Module vrLightLinkSetPtr :: Class vrLightLinkSetPtr

Class vrLightLinkSetPtr

 object --+        
          |        
??.instance --+    
              |    
LightLinkSetPtr --+
                  |
                 vrLightLinkSetPtr

Deprecated. Use API v2 vrdLightLinkSetNode instead.

Instance Methods

__init__(source)
The constructor of the LightLinkSetPtr class.

addLight(light)
Adds a light to the light linking set.

addSceneNode(sceneNode)
Adds a scene node to the light linking set.

vrLightLinkSetPtr

copy()
Returns a copy of the lightlinkset.

vrFieldAccess

fields()
Returns the field access object to get access to all fields.

unsigned int (32bit)

getID()
Return the set id.

list of vrNodePtrs

getLights()
Returns all lights in the light linking set.

string

getName()
Returns the name of the set.

LightLinkSetPtr

getPtr()
Return the OpenSG LightLinkSetPtr.

list of vrNodePtrs

getSceneNodes()
Returns all scene nodes in the light linking set.

string

getType()
Returns the type of the set.

bool

isValid()
Return true when the set is valid.

setName(name)
Sets the name of the set.

sub(update)
Removes the light link set from the pool.

subLight(light)
Subs a light from the light linking set.

subSceneNode(sceneNode)
Subs a scene node from the light linking set.

Inherited from LightLinkSetPtr: __reduce__

Inherited from unreachable.instance: __new__

Class Variables
	__instance_size__ = `64`

Method Details

init(source)
(Constructor)

The constructor of the LightLinkSetPtr class. There are three valid versions:

LightLinkSetPtr() Creates a LightLinkSetPtr object.

LightLinkSetPtr(source) Creates a LightLinkSetPtr object from an unsigned int.

LightLinkSetPtr(source) Creates a LightLinkSetPtr object from a LightLinkSetPtr.

Parameters:

source (unsigned int or LightLinkSetPtr) - The source (Optional).

Overrides: LightLinkSetPtr.__init__

addLight(light)

Adds a light to the light linking set.

Parameters:

light (vrNodePtr) - The light node.

addSceneNode(sceneNode)

Adds a scene node to the light linking set.

Parameters:

sceneNode (vrNodePtr) - The scene node node.

copy()

Returns a copy of the lightlinkset.

Returns: vrLightLinkSetPtr: The copy.

fields()

Returns the field access object to get access to all fields. Take a look at the vrFieldAccess documentation to see how to manipulate the value of the fields.

Returns: vrFieldAccess: The field access object.

getID()

Return the set id.

Returns: unsigned int (32bit): The set id.

getLights()

Returns all lights in the light linking set.

Returns: list of vrNodePtrs: The light nodes.

getName()

Returns the name of the set.

Returns: string: The name of the set.

getPtr()

Return the OpenSG LightLinkSetPtr.

Returns: LightLinkSetPtr: The pointer.

getSceneNodes()

Returns all scene nodes in the light linking set.

Returns: list of vrNodePtrs: The scene nodes.

getType()

Returns the type of the set.

Returns: string: The type of the set.

isValid()

Return true when the set is valid.

Returns: bool: True when the set is valid, false otherwise.

setName(name)

Sets the name of the set.

Parameters:

name (string) - The new name of the set.

sub(update)

Removes the light link set from the pool.

Parameters:

update (bool) - If true the light editor is updated (Optional). Default is true.

subLight(light)

Subs a light from the light linking set.

Parameters:

light (vrNodePtr) - The light node.

subSceneNode(sceneNode)

Subs a scene node from the light linking set.

Parameters:

sceneNode (vrNodePtr) - The scene node.

Class vrLightLinkSetPtr

__init__(source) (Constructor)

addLight(light)

addSceneNode(sceneNode)

copy()

fields()

getID()

getLights()

getName()

getPtr()

getSceneNodes()

getType()

isValid()

setName(name)

sub(update)

subLight(light)

subSceneNode(sceneNode)

init(source)
(Constructor)