Difference between revisions of "George Commands : Guidelines"

Revision as of 14:40, 30 August 2013

<<<George<<<Command Reference

• tv_guidelineAdd
• tv_guidelinemodify
• tv_guidelineremove
• tv_guidelinevisible
• tv_guidelinesnap
• tv_guidelinecollapse
• tv_guidelinemarge
• tv_guidelinecolor
• tv_guidelineenum

//returns number < 0 if error
//returns the previous state (0|1) if index is used
//returns nothing if several guidelines changed
tv_guidelinevisible "all"|"line"|"circle"|"segment"|"grid"|...|index 0|1|"on"|"off"|"true"|"false"|"toggle"
//returns the state of the guideline
tv_guidelinevisible index

//returns number < 0 if error
//returns the previous state (0|1) if index is used
//returns nothing if several guidelines changed
tv_guidelinesnap "all"|"line"|"circle"|"segment"|"grid"|...|index 0|1|"on"|"off"|"true"|"false"|"toggle"
//returns the state of the guideline
tv_guidelinesnap index

//returns number < 0 if error
//returns the previous state (0|1) if index is used
//returns nothing if several guidelines changed
tv_guidelinecollapse "all"|"line"|"circle"|"segment"|"grid"|...|index 0|1|"on"|"off"|"true"|"false"|"toggle"
//returns the state of the guideline
tv_guidelinecollapse index

//returns number < 0 if error
//returns the previous marge if index is used
//returns nothing if several guidelines changed
tv_guidelinemarge "all"|"line"|"circle"|"segment"|"grid"|...|index new-marge
//returns the marge of the guideline
tv_guidelinecollapse index

//returns number < 0 if error
//returns the previous color if index is used
//returns nothing if several guidelines changed
tv_guidelinecolor "all"|"line"|"circle"|"segment"|"grid"|...|index r g b a
//returns the color of the guideline
tv_guidelinecolor

//returns number < 0 if error
//returns the index of the found guideline at the given position in the whole list
//returns "none" if no guideline found
//in this first case, the returned index = given position
tv_guidelineenum position
//returns the index of the found guideline at the given position in the list made of the wanted type
//returns "none" if no guideline found
tv_guidelineenum position "line"|"circle"|"segment"|"grid"|...

e.g.: list of guidelines
- 0 line
- 1 segment
- 2 circle
- 3 circle
- 4 segment
- 5 line

tv_guidelineenum 0 "circle" -> 2
tv_guidelineenum 1 "circle" -> 3
tv_guidelineenum 2 "circle" -> "none"
tv_guidelineenum 0 "segment" -> 1
tv_guidelineenum 1 "segment" -> 4

//returns "ERROR" if error
//returns the name of the guideline
tv_guidelinename position
//returns the previous name of the guideline
tv_guidelinename position new-name