Trees       Indices       Help   
VRED Python API v1
Module vrVariantSetPtr :: Class vrVariantSetPtr
[frames] | no frames]

Class vrVariantSetPtr

 object --+    
          |    
??.instance --+
              |
             vrVariantSetPtr

The vrVariantSetPtr is a wrapper class for vrVariantSet.

Instance Methods
 
__init__()
 
__reduce__()
 
addClippingPlane(position, normal, invertDirection, hideScene, showClippingPlane, showGrid, showContour)
Adds a Clipping Plane.
 
addCurrentClippingPlane()
Adds current Clipping Plane.
 
addGeometry(node, state)
Adds a geometry variant.
 
addLight(node, state)
Adds a light variant.
 
addMaterial(node, state)
Adds a material variant.
 
addScript(script)
Adds a script.
 
addTransform(node, state)
Adds a transform variant.
 
addView(viewpoint)
Adds a viewpoint.
string
getHotkey()
Gets the Key.
string
getName()
Gets the Name.
string
getScript()
Gets the script.
vector of string
getTargetNodeNames()
Gets the names of the target nodes.
string
getValue(key)
Gets the value stored for the given key.
 
setClippingState(state)
Sets the clipping state.
 
setHotkey(key, modifier)
Sets a Key.
 
setHotkeyString(key)
Sets a Key.
 
setName(name)
Sets a Name.
 
setValue(key, value)
Adds a key/value pair to the variant set.

Inherited from unreachable.instance: __new__

Class Variables
  __instance_size__ = 32
Method Details

__init__()
(Constructor)

 
Overrides: object.__init__
(inherited documentation)

__reduce__()

 
Overrides: object.__reduce__
(inherited documentation)

addClippingPlane(position, normal, invertDirection, hideScene, showClippingPlane, showGrid, showContour)

 

Adds a Clipping Plane.

Parameters:
  • position (bool) - The position.
  • normal (bool) - The normal.
  • invertDirection (bool) - Toggle invert direction.
  • hideScene (bool) - Toggle hide scene.
  • showClippingPlane (bool) - Toggle show clipping plane.
  • showGrid (bool) - Toggle show grid.
  • showContour (bool) - Toggle show contour.

addGeometry(node, state)

 

Adds a geometry variant.

Parameters:
  • node (vrNodePtr) - The geometry switch.
  • state (string) - The node state.

addLight(node, state)

 

Adds a light variant.

Parameters:
  • node (vrNodePtr) - The light switch.
  • state (string) - The light state.

addMaterial(node, state)

 

Adds a material variant.

Parameters:
  • node (vrMaterialPtr) - The material switch.
  • state (string) - The material state.

addScript(script)

 

Adds a script.

Parameters:
  • script (string) - The script.

addTransform(node, state)

 

Adds a transform variant.

Parameters:
  • node (vrNodePtr) - The node holding transform variants.
  • state (string) - The node state.

addView(viewpoint)

 

Adds a viewpoint.

Parameters:
  • viewpoint (string) - The viewpoint.

getHotkey()

 

Gets the Key.

Returns: string
The Key.

getName()

 

Gets the Name.

Returns: string
The Name.

getScript()

 

Gets the script.

Returns: string
The script.

getTargetNodeNames()

 

Gets the names of the target nodes.

Returns: vector of string
The names.

getValue(key)

 

Gets the value stored for the given key.

Parameters:
  • key (string) - The key for which the value should be returned.
Returns: string
The value. Empty string if the variant set does not contain the given key.

setClippingState(state)

 

Sets the clipping state.

Parameters:
  • state (string) - The clippping state (0=no change, 1=enable clipping, 2=disable clipping, 3=set clipping plane values but keep the rest)).

setHotkey(key, modifier)

 

Sets a Key.

Parameters:
  • key (integer (unsigned)) - The Key.
  • modifier (integer (unsigned)) - The modifier.

setHotkeyString(key)

 

Sets a Key.

Parameters:
  • key (string) - The Key.

setName(name)

 

Sets a Name.

Parameters:
  • name (string) - The Name.

setValue(key, value)

 

Adds a key/value pair to the variant set. Keys are unique. Setting another value for the same key overwrites the previous value.

Parameters:
  • key (string) - The key.
  • value (string) - The value.

   Trees       Indices       Help   
VRED Python API v1
Generated by Epydoc 3.0.1 on Fri Nov 29 09:33:22 2024 http://epydoc.sourceforge.net