set node

Summary

The set node changes the value of a boolean parameter of another node.

For more information see the XML reference entry for set.

Constructor

set.new( node , what , [id] )

The node parameter indicates the node with the setting to change.

The what parameter identifies which setting to change. Currently the only accepted value is visible.

The parameter id is optional. If specified the node will be given this id.

Example C.68. Use of set constructor

<scene>
	<script type="text/x-lua">
	
		myplane = scene:getById("myplane")
		
		myset = set.new(myplane, "visible")
		myset:to(false)
		
		scene:appendNode(myset)
		
	</script>
	
	<object id="myplane" type="primitives://plane.aro"/>
	
</scene>

Functions

node:to( boolean_value )

Indicates the value that the node should set the parameter to when it is actioned.

Example C.69. Use of to

<scene>
	<script type="text/x-lua">
	
		myplane = scene:getById("myplane")
		
		myset = set.new(myplane, "visible")
		myset:to(false)
		
		scene:appendNode(myset)
		
	</script>
	
	<object id="myplane" type="primitives://plane.aro"/>

</scene>


Functions common to action nodes

node:reset()

Resets this action such that it will occur again (from the beginning).

node:setNoTimes( val )

Sets the number of times this action should occur. Pass the value -1 to repeat indefinitely.

Example C.70. Use of setNoTimes

<scene>
	<script type="text/x-lua">
		
		mytransition = scene:getById("mytransition")
		
		mytransition:setNoTimes(10)
		
	</script>
	
	<transition id="mytransition"
				object="myplane" 
				what="position" 
				start="0 0 0" end="1 1 1" 
				length="1000 />

	<object id="myplane" type="primitives://plane.aro"/>
	
</scene>


Functions common to nodes

col graphnode:getColor()

Returns a table of 4 values - red, green, blue and alpha (transparency) between 0.0 and 1.0.

Example C.71. Use of getColor

<scene>
	<script type="text/x-lua">
		
		myplane = scene:getById("myplane")
		cols = myplace:getColor()
		red = cols[1]
		green = cols[2]
		blue = cols[3]
		alpha = cols[4]
		
	</script>
	<object id="myplane" type="primitives://plane.aro" color="0.5 1 1 0.75"/>
</scene>


boolean graphnode:isVisible()

Returns true if the node is set to visible, or false otherwise.

graphnode:setColor( col )

Sets the color of the node. Pass a 4-element table with entries { red, green, blue, alpha }. Values are expressed between 0.0 and 1.0.

Example C.72. Use of setColor

<scene>
	<script type="text/x-lua">
		
		myplane = scene:getById("myplane")
		
		--         r    g   b    a
		newcol = { 0.1, 1, 0.5, 0.25 } 
		myplane:setColor(newcol)
		
	</script>
	<object id="myplane" type="primitives://plane.aro"/>
</scene>


graphnode:setVisible( true or false )

Sets the visibility of the node. Invisible nodes are not displayed and do not respond to events e.g. onhover, onclickdown etc.