Skip to main content

Properties

Module: Nodes

Functions for accessing node properties.

Functions​

TypeName
intVRGetEnumValue(HNode node, const char * symbol)
Gets the value of an enum symbol in the context of the specified node type.
intVRGetEnumValueEx(const char * metanode, const char * symbol)
Gets the value of an enum symbol in the context of the specified node type.
uint32_tVRGetProperty(HNode node, const char * propName)
Gets a reusable property handle. Even though this uses a node handle to get a property index, the property index can still be used to interact with the property on any instance of the metanode. (not just this single instance of node)
size_tVRGetPropertyArrayDouble(HNode node, const char * propName, double * buffer, size_t bufferSize)
Gets a DOUBLE array element from a node property.
size_tVRGetPropertyArrayDoubleEx(HNode node, uint32_t prop, double * buffer, size_t bufferSize)
Gets the DOUBLE array from the property a node.
size_tVRGetPropertyArrayFloat(HNode node, const char * propName, float * buffer, size_t bufferSize)
Gets a FLOAT array from a node property.
size_tVRGetPropertyArrayFloatEx(HNode node, uint32_t prop, float * buffer, size_t bufferSize)
Gets the FLOAT array from the property a node.
size_tVRGetPropertyArrayWorldFloat(HNode node, const char * propName, void * buffer, size_t bufferSize)
Gets a WORLD_FLOAT array element from a node property.
size_tVRGetPropertyArrayWorldFloatEx(HNode node, uint32_t prop, void * buffer, size_t bufferSize)
Gets the WORLD_FLOAT array from the property a node.
charVRGetPropertyChar(HNode node, const char * propName)
Gets a CHAR or BOOL property from a node.
charVRGetPropertyCharElement(HNode node, const char * propName, size_t index)
Gets a CHAR or BOOL array element from a node property.
charVRGetPropertyCharElementEx(HNode node, uint32_t prop, size_t index)
Gets a CHAR or BOOL array element from a node property.
charVRGetPropertyCharEx(HNode node, uint32_t prop)
Gets a CHAR or BOOL property from a node.
doubleVRGetPropertyDouble(HNode node, const char * propName)
Gets a DOUBLE property from a node.
doubleVRGetPropertyDoubleElement(HNode node, const char * propName, size_t index)
Gets a DOUBLE array element from a node property.
doubleVRGetPropertyDoubleElementEx(HNode node, uint32_t prop, size_t index)
Gets a DOUBLE array element from a node property.
doubleVRGetPropertyDoubleEx(HNode node, uint32_t prop)
Gets a DOUBLE property from a node.
uint32_tVRGetPropertyEx(const char * metaName, const char * propName)
Gets a reusable property handle from a metanode name.
floatVRGetPropertyFloat(HNode node, const char * propName)
Gets a FLOAT property from a node.
floatVRGetPropertyFloatElement(HNode node, const char * propName, size_t index)
Gets a FLOAT array element from a node property.
floatVRGetPropertyFloatElementEx(HNode node, uint32_t prop, size_t index)
Gets a FLOAT array element from a node property.
floatVRGetPropertyFloatEx(HNode node, uint32_t prop)
Gets a FLOAT property from a node.
intVRGetPropertyInt(HNode node, const char * propName)
Gets an INT property from a node.
intVRGetPropertyIntElement(HNode node, const char * propName, size_t index)
Gets an INT array element from a node property.
intVRGetPropertyIntElementEx(HNode node, uint32_t prop, size_t index)
Gets an INT array element from a node property.
intVRGetPropertyIntEx(HNode node, uint32_t prop)
Gets an INT property from a node.
HNodeVRGetPropertyLink(HNode node, const char * propName)
Gets a LINK property from a node.
HNodeVRGetPropertyLinkEx(HNode node, uint32_t prop)
Gets a LINK property from a node.
size_tVRGetPropertyString(HNode node, const char * propName, char * buffer, size_t bufferSize)
Gets a STRING property from a node.
const char *VRGetPropertyStringElement(HNode node, const char * propName, size_t index)
Gets a STRING array element from a node property.
const char *VRGetPropertyStringElementEx(HNode node, uint32_t prop, size_t index)
Gets a STRING array element from a node property.
size_tVRGetPropertyStringEx(HNode node, uint32_t prop, char * buffer, size_t bufferSize)
Gets a STRING property from a node.
size_tVRGetPropertyValue(HNode node, const char * propName, void * valueBuffer, size_t bufferSize)
Gets a property from a node.
size_tVRGetPropertyValueEx(HNode node, uint32_t prop, void * valueBuffer, size_t bufferSize)
Gets a property from a node.
size_tVRGetPropertyValueSize(HNode node, const char * propName)
Gets the required size of a buffer to pass to VRGetPropertyValue. In the case of string properties, returns the length of the string including null terminator.
size_tVRGetPropertyValueSizeEx(HNode node, uint32_t prop)
Gets the required size of a buffer to pass to VRGetPropertyValue In the case of string properties, returns the length of the string including null terminator.
intVRGetWorldTransform(HNode node, const char * propName, void * valueBuffer, size_t bufferSize)
Gets the world transform of the specified node from the transform hierarchy. Internally calls TransformHierarchy::getWorldTransformSafe unless a propName is specified.
intVRIsPropertyEnumValue(HNode node, const char * propName, const char * symbol)
Gets the int value of symbol and checks if the specified INT property is currently set to that value.
intVRIsPropertyEnumValueEx(HNode node, uint32_t prop, const char * symbol)
Gets the int value of symbol and checks if the specified INT property is currently set to that value.
intVRSetPropertyArrayDouble(HNode node, const char * propName, double * valueData, size_t arraySize)
Sets an array of doubles property on a node (useful to set matrices)
intVRSetPropertyArrayDoubleEx(HNode node, uint32_t prop, double * valueData, size_t arraySize, uint32_t flags, int userChange)
Sets an element in a double array property on a node.
intVRSetPropertyArrayFloat(HNode node, const char * propName, float * valueData, size_t arraySize)
Sets an array of floats property on a node (useful to set matrices)
intVRSetPropertyArrayFloatEx(HNode node, uint32_t prop, float * valueData, size_t arraySize, uint32_t flags, int userChange)
Sets an element in a float array property on a node.
intVRSetPropertyArrayWorldFloat(HNode node, const char * propName, void * valueData, size_t arraySize)
Sets an array of world float property on a node (useful to set matrices)
intVRSetPropertyArrayWorldFloatEx(HNode node, uint32_t prop, void * valueData, size_t arraySize, uint32_t flags, int userChange)
Sets an element in a world float array property on a node.
intVRSetPropertyChar(HNode node, const char * propName, char value)
Sets a CHAR or BOOL property on a node.
intVRSetPropertyCharElement(HNode node, const char * propName, size_t index, char value)
Sets an element in a CHAR or BOOL array property on a node.
intVRSetPropertyCharElementEx(HNode node, uint32_t prop, size_t index, char value, uint32_t flags, int userChange)
Sets an element in a CHAR or BOOL array property on a node.
intVRSetPropertyCharEx(HNode node, uint32_t prop, char value, uint32_t flags, int userChange)
Sets a CHAR or BOOL property on a node.
intVRSetPropertyDouble(HNode node, const char * propName, double value)
Sets a DOUBLE property on a node.
intVRSetPropertyDoubleElement(HNode node, const char * propName, size_t index, double value)
Sets an element in a DOUBLE array property on a node.
intVRSetPropertyDoubleElementEx(HNode node, uint32_t prop, size_t index, double value, uint32_t flags, int userChange)
Sets an element in a DOUBLE array property on a node.
intVRSetPropertyDoubleEx(HNode node, uint32_t prop, double value, uint32_t flags, int userChange)
Sets a DOUBLE property on a node.
intVRSetPropertyEnum(HNode node, const char * propName, const char * symbol)
Sets an INT property on a node using the value of a symbol.
intVRSetPropertyEnumEx(HNode node, uint32_t prop, const char * symbol, uint32_t flags, int userChange)
Sets an INT property on a node using the value of a symbol.
intVRSetPropertyFloat(HNode node, const char * propName, float value)
Sets a FLOAT property on a node.
intVRSetPropertyFloatElement(HNode node, const char * propName, size_t index, float value)
Sets an element in a FLOAT array property on a node.
intVRSetPropertyFloatElementEx(HNode node, uint32_t prop, size_t index, float value, uint32_t flags, int userChange)
Sets an element in a FLOAT array property on a node.
intVRSetPropertyFloatEx(HNode node, uint32_t prop, float value, uint32_t flags, int userChange)
Sets a FLOAT property on a node.
intVRSetPropertyInt(HNode node, const char * propName, int value)
Sets an INT property on a node.
intVRSetPropertyIntElement(HNode node, const char * propName, size_t index, int value)
Sets an element in a INT array property on a node.
intVRSetPropertyIntElementEx(HNode node, uint32_t prop, size_t index, int value, uint32_t flags, int userChange)
Sets an element in a INT array property on a node.
intVRSetPropertyIntEx(HNode node, uint32_t prop, int value, uint32_t flags, int userChange)
Sets an INT property on a node.
intVRSetPropertyLink(HNode node, const char * propName, HNode linkTarget)
Sets a LINK property on a node.
intVRSetPropertyLinkEx(HNode node, uint32_t prop, HNode linkTarget, uint32_t flags, int userChange)
Sets a LINK property on a node.
intVRSetPropertyString(HNode node, const char * propName, const char * stringData)
Sets a STRING property on a node.
intVRSetPropertyStringElement(HNode node, const char * propName, size_t index, const char * value, size_t valueSize)
Sets an element in a STRING array property on a node.
intVRSetPropertyStringElementEx(HNode node, uint32_t prop, size_t index, const char * values, size_t arraySize, uint32_t flags, int userChange)
Sets an element in a STRING array property on a node.
intVRSetPropertyStringEx(HNode node, uint32_t prop, const char * stringData, uint32_t flags, int userChange)
Sets a STRING property on a node.
intVRSetPropertyValue(HNode node, const char * propName, const void * valueData, size_t valueSize)
Sets a property value on a node.
intVRSetPropertyValueEx(HNode node, uint32_t prop, const void * valueData, size_t valueSize, uint32_t flags, int userChange)
Sets a property value on a node.

Functions Documentation​

VRGetEnumValue​

int VRGetEnumValue(
    HNode node,
    const char * symbol
)

Gets the value of an enum symbol in the context of the specified node type.

VRGetEnumValueEx​

int VRGetEnumValueEx(
    const char * metanode,
    const char * symbol
)

Gets the value of an enum symbol in the context of the specified node type.

VRGetProperty​

uint32_t VRGetProperty(
    HNode node,
    const char * propName
)

Gets a reusable property handle. Even though this uses a node handle to get a property index, the property index can still be used to interact with the property on any instance of the metanode. (not just this single instance of node)

Parameters:

  • node handle to node to use for its metanode
  • propName name of the property on this node

See: VRGetProperty(nodePropName)

Return: property index or PROPERTY_INVALID_INDEX

VRGetPropertyArrayDouble​

size_t VRGetPropertyArrayDouble(
    HNode node,
    const char * propName,
    double * buffer,
    size_t bufferSize
)

Gets a DOUBLE array element from a node property.

Parameters:

  • buffer the buffer to store the data in
  • bufferSize the size of the buffer to store the data in

See: VRGetPropertyValue()

Return: the size of the data buffer

VRGetPropertyArrayDoubleEx​

size_t VRGetPropertyArrayDoubleEx(
    HNode node,
    uint32_t prop,
    double * buffer,
    size_t bufferSize
)

Gets the DOUBLE array from the property a node.

Parameters:

  • buffer the buffer to store the data in
  • bufferSize size of the buffer

See: VRGetPropertyValueEx()

Return: size of the buffer

VRGetPropertyArrayFloat​

size_t VRGetPropertyArrayFloat(
    HNode node,
    const char * propName,
    float * buffer,
    size_t bufferSize
)

Gets a FLOAT array from a node property.

Parameters:

  • buffer the buffer to store the data in
  • bufferSize size of the buffer

See: VRGetPropertyValue()

Return: size of the buffer

VRGetPropertyArrayFloatEx​

size_t VRGetPropertyArrayFloatEx(
    HNode node,
    uint32_t prop,
    float * buffer,
    size_t bufferSize
)

Gets the FLOAT array from the property a node.

Parameters:

  • buffer the buffer to store the data in
  • bufferSize size of the buffer

See: VRGetPropertyValueEx()

Return: size of the buffer

VRGetPropertyArrayWorldFloat​

size_t VRGetPropertyArrayWorldFloat(
    HNode node,
    const char * propName,
    void * buffer,
    size_t bufferSize
)

Gets a WORLD_FLOAT array element from a node property.

Parameters:

  • buffer the buffer to store the data in
  • bufferSize the size of the buffer to store the data in

See: VRGetPropertyValue()

Return: the size of the data buffer

VRGetPropertyArrayWorldFloatEx​

size_t VRGetPropertyArrayWorldFloatEx(
    HNode node,
    uint32_t prop,
    void * buffer,
    size_t bufferSize
)

Gets the WORLD_FLOAT array from the property a node.

Parameters:

  • buffer the buffer to store the data in
  • bufferSize size of the buffer

See: VRGetPropertyValueEx()

Return: size of the buffer

VRGetPropertyChar​

char VRGetPropertyChar(
    HNode node,
    const char * propName
)

Gets a CHAR or BOOL property from a node.

See: VRGetPropertyValue()

Return: the value

VRGetPropertyCharElement​

char VRGetPropertyCharElement(
    HNode node,
    const char * propName,
    size_t index
)

Gets a CHAR or BOOL array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValue()

Return: the value

VRGetPropertyCharElementEx​

char VRGetPropertyCharElementEx(
    HNode node,
    uint32_t prop,
    size_t index
)

Gets a CHAR or BOOL array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValueEx()

Return: the value

VRGetPropertyCharEx​

char VRGetPropertyCharEx(
    HNode node,
    uint32_t prop
)

Gets a CHAR or BOOL property from a node.

See: VRGetPropertyValueEx()

Return: the value

VRGetPropertyDouble​

double VRGetPropertyDouble(
    HNode node,
    const char * propName
)

Gets a DOUBLE property from a node.

See: VRGetPropertyValue()

Return: the value

VRGetPropertyDoubleElement​

double VRGetPropertyDoubleElement(
    HNode node,
    const char * propName,
    size_t index
)

Gets a DOUBLE array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValue()

Return: the value

VRGetPropertyDoubleElementEx​

double VRGetPropertyDoubleElementEx(
    HNode node,
    uint32_t prop,
    size_t index
)

Gets a DOUBLE array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValueEx()

Return: the value

VRGetPropertyDoubleEx​

double VRGetPropertyDoubleEx(
    HNode node,
    uint32_t prop
)

Gets a DOUBLE property from a node.

See: VRGetPropertyValueEx()

Return: the value

VRGetPropertyEx​

uint32_t VRGetPropertyEx(
    const char * metaName,
    const char * propName
)

Gets a reusable property handle from a metanode name.

Parameters:

  • metaName name of the metanode
  • propName name of the property on the metaname

Return: property index or PROPERTY_INVALID_INDEX

VRGetPropertyFloat​

float VRGetPropertyFloat(
    HNode node,
    const char * propName
)

Gets a FLOAT property from a node.

See: VRGetPropertyValue()

Return: the value

VRGetPropertyFloatElement​

float VRGetPropertyFloatElement(
    HNode node,
    const char * propName,
    size_t index
)

Gets a FLOAT array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValue()

Return: the value

VRGetPropertyFloatElementEx​

float VRGetPropertyFloatElementEx(
    HNode node,
    uint32_t prop,
    size_t index
)

Gets a FLOAT array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValueEx()

Return: the value

VRGetPropertyFloatEx​

float VRGetPropertyFloatEx(
    HNode node,
    uint32_t prop
)

Gets a FLOAT property from a node.

See: VRGetPropertyValueEx()

Return: the value

VRGetPropertyInt​

int VRGetPropertyInt(
    HNode node,
    const char * propName
)

Gets an INT property from a node.

See: VRGetPropertyValue()

Return: the value

VRGetPropertyIntElement​

int VRGetPropertyIntElement(
    HNode node,
    const char * propName,
    size_t index
)

Gets an INT array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValue()

Return: the value

VRGetPropertyIntElementEx​

int VRGetPropertyIntElementEx(
    HNode node,
    uint32_t prop,
    size_t index
)

Gets an INT array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValueEx()

Return: the value

VRGetPropertyIntEx​

int VRGetPropertyIntEx(
    HNode node,
    uint32_t prop
)

Gets an INT property from a node.

See: VRGetPropertyValueEx()

Return: the value

HNode VRGetPropertyLink(
    HNode node,
    const char * propName
)

Gets a LINK property from a node.

See: VRGetPropertyValue()

Return: handle to the link target node

VRGetPropertyLinkEx​

HNode VRGetPropertyLinkEx(
    HNode node,
    uint32_t prop
)

Gets a LINK property from a node.

See: VRGetPropertyValueEx()

Return: handle to the link target node

VRGetPropertyString​

size_t VRGetPropertyString(
    HNode node,
    const char * propName,
    char * buffer,
    size_t bufferSize
)

Gets a STRING property from a node.

Parameters:

  • buffer buffer to receive the string data
  • bufferSize size of the buffer

See: VRGetPropertyValue()

Return: the number of bytes written to the buffer

Note: if buffer is null, function returns the required size of the buffer

VRGetPropertyStringElement​

const char * VRGetPropertyStringElement(
    HNode node,
    const char * propName,
    size_t index
)

Gets a STRING array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValue()

Return: the value

VRGetPropertyStringElementEx​

const char * VRGetPropertyStringElementEx(
    HNode node,
    uint32_t prop,
    size_t index
)

Gets a STRING array element from a node property.

Parameters:

  • index index of array to read

See: VRGetPropertyValueEx()

Return: the value

VRGetPropertyStringEx​

size_t VRGetPropertyStringEx(
    HNode node,
    uint32_t prop,
    char * buffer,
    size_t bufferSize
)

Gets a STRING property from a node.

Parameters:

  • buffer buffer to receive the string data
  • bufferSize size of the buffer

See: VRGetPropertyValueEx()

Return: the number of bytes written to the buffer

Note: if buffer is null, function returns the required size of the buffer

VRGetPropertyValue​

size_t VRGetPropertyValue(
    HNode node,
    const char * propName,
    void * valueBuffer,
    size_t bufferSize
)

Gets a property from a node.

Parameters:

  • node node to read property from
  • propName name of the property to read
  • valueBuffer buffer to receive the data
  • bufferSize size of the buffer

Return: number of bytes written to buffer on success

VRGetPropertyValueEx​

size_t VRGetPropertyValueEx(
    HNode node,
    uint32_t prop,
    void * valueBuffer,
    size_t bufferSize
)

Gets a property from a node.

Parameters:

  • node node to read property from
  • prop the property to read
  • valueBuffer buffer to receive the data
  • bufferSize size of the buffer

Return: number of bytes written to buffer on success

VRGetPropertyValueSize​

size_t VRGetPropertyValueSize(
    HNode node,
    const char * propName
)

Gets the required size of a buffer to pass to VRGetPropertyValue. In the case of string properties, returns the length of the string including null terminator.

Parameters:

  • node node to read from
  • propName property to get the size of

Return: number of bytes required to hold the property data

VRGetPropertyValueSizeEx​

size_t VRGetPropertyValueSizeEx(
    HNode node,
    uint32_t prop
)

Gets the required size of a buffer to pass to VRGetPropertyValue In the case of string properties, returns the length of the string including null terminator.

Parameters:

  • node node to read from
  • prop property to get the size of

Return: number of bytes required to hold the property data

VRGetWorldTransform​

int VRGetWorldTransform(
    HNode node,
    const char * propName,
    void * valueBuffer,
    size_t bufferSize
)

Gets the world transform of the specified node from the transform hierarchy. Internally calls TransformHierarchy::getWorldTransformSafe unless a propName is specified.

Parameters:

  • node the node to get the world transform of
  • propName optional name of the property containing the transform, for node types not managed by the transform hierarchy. In most cases can be NULL
  • valueBuffer buffer to populate with the world transform matrix
  • bufferSize size of the buffer

Return: 0 on failure, number of bytes written to valueBuffer on success

VRIsPropertyEnumValue​

int VRIsPropertyEnumValue(
    HNode node,
    const char * propName,
    const char * symbol
)

Gets the int value of symbol and checks if the specified INT property is currently set to that value.

VRIsPropertyEnumValueEx​

int VRIsPropertyEnumValueEx(
    HNode node,
    uint32_t prop,
    const char * symbol
)

Gets the int value of symbol and checks if the specified INT property is currently set to that value.

VRSetPropertyArrayDouble​

int VRSetPropertyArrayDouble(
    HNode node,
    const char * propName,
    double * valueData,
    size_t arraySize
)

Sets an array of doubles property on a node (useful to set matrices)

Parameters:

  • valueData double precision data to set
  • arraySize the size of the data buffer

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyArrayDoubleEx​

int VRSetPropertyArrayDoubleEx(
    HNode node,
    uint32_t prop,
    double * valueData,
    size_t arraySize,
    uint32_t flags,
    int userChange
)

Sets an element in a double array property on a node.

Parameters:

  • valueData data to set
  • arraySize size of the data buffer

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyArrayFloat​

int VRSetPropertyArrayFloat(
    HNode node,
    const char * propName,
    float * valueData,
    size_t arraySize
)

Sets an array of floats property on a node (useful to set matrices)

Parameters:

  • valueData single precision data to set
  • arraySize the size of the data buffer

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyArrayFloatEx​

int VRSetPropertyArrayFloatEx(
    HNode node,
    uint32_t prop,
    float * valueData,
    size_t arraySize,
    uint32_t flags,
    int userChange
)

Sets an element in a float array property on a node.

Parameters:

  • valueData data to set
  • arraySize size of the data buffer

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyArrayWorldFloat​

int VRSetPropertyArrayWorldFloat(
    HNode node,
    const char * propName,
    void * valueData,
    size_t arraySize
)

Sets an array of world float property on a node (useful to set matrices)

Parameters:

  • valueData data to set
  • arraySize the size of the data buffer

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyArrayWorldFloatEx​

int VRSetPropertyArrayWorldFloatEx(
    HNode node,
    uint32_t prop,
    void * valueData,
    size_t arraySize,
    uint32_t flags,
    int userChange
)

Sets an element in a world float array property on a node.

Parameters:

  • valueData data to set
  • arraySize size of the data buffer

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyChar​

int VRSetPropertyChar(
    HNode node,
    const char * propName,
    char value
)

Sets a CHAR or BOOL property on a node.

Parameters:

  • value value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyCharElement​

int VRSetPropertyCharElement(
    HNode node,
    const char * propName,
    size_t index,
    char value
)

Sets an element in a CHAR or BOOL array property on a node.

Parameters:

  • index element to set (0-based array index)
  • value value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyCharElementEx​

int VRSetPropertyCharElementEx(
    HNode node,
    uint32_t prop,
    size_t index,
    char value,
    uint32_t flags,
    int userChange
)

Sets an element in a CHAR or BOOL array property on a node.

Parameters:

  • index element to set (0-based array index)
  • value value to set

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyCharEx​

int VRSetPropertyCharEx(
    HNode node,
    uint32_t prop,
    char value,
    uint32_t flags,
    int userChange
)

Sets a CHAR or BOOL property on a node.

Parameters:

  • value value to set

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyDouble​

int VRSetPropertyDouble(
    HNode node,
    const char * propName,
    double value
)

Sets a DOUBLE property on a node.

Parameters:

  • value value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyDoubleElement​

int VRSetPropertyDoubleElement(
    HNode node,
    const char * propName,
    size_t index,
    double value
)

Sets an element in a DOUBLE array property on a node.

Parameters:

  • index element to set (0-based array index)
  • value value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyDoubleElementEx​

int VRSetPropertyDoubleElementEx(
    HNode node,
    uint32_t prop,
    size_t index,
    double value,
    uint32_t flags,
    int userChange
)

Sets an element in a DOUBLE array property on a node.

Parameters:

  • index element to set (0-based array index)
  • value value to set

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyDoubleEx​

int VRSetPropertyDoubleEx(
    HNode node,
    uint32_t prop,
    double value,
    uint32_t flags,
    int userChange
)

Sets a DOUBLE property on a node.

Parameters:

  • value value to set

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyEnum​

int VRSetPropertyEnum(
    HNode node,
    const char * propName,
    const char * symbol
)

Sets an INT property on a node using the value of a symbol.

Parameters:

  • symbol name of the symbol to read the value from

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyEnumEx​

int VRSetPropertyEnumEx(
    HNode node,
    uint32_t prop,
    const char * symbol,
    uint32_t flags,
    int userChange
)

Sets an INT property on a node using the value of a symbol.

Parameters:

  • symbol name of the symbol to read the value from

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyFloat​

int VRSetPropertyFloat(
    HNode node,
    const char * propName,
    float value
)

Sets a FLOAT property on a node.

Parameters:

  • value value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyFloatElement​

int VRSetPropertyFloatElement(
    HNode node,
    const char * propName,
    size_t index,
    float value
)

Sets an element in a FLOAT array property on a node.

Parameters:

  • index element to set (0-based array index)
  • value value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyFloatElementEx​

int VRSetPropertyFloatElementEx(
    HNode node,
    uint32_t prop,
    size_t index,
    float value,
    uint32_t flags,
    int userChange
)

Sets an element in a FLOAT array property on a node.

Parameters:

  • index element to set (0-based array index)
  • value value to set

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyFloatEx​

int VRSetPropertyFloatEx(
    HNode node,
    uint32_t prop,
    float value,
    uint32_t flags,
    int userChange
)

Sets a FLOAT property on a node.

Parameters:

  • value value to set

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyInt​

int VRSetPropertyInt(
    HNode node,
    const char * propName,
    int value
)

Sets an INT property on a node.

Parameters:

  • value value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyIntElement​

int VRSetPropertyIntElement(
    HNode node,
    const char * propName,
    size_t index,
    int value
)

Sets an element in a INT array property on a node.

Parameters:

  • index element to set (0-based array index)
  • value value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyIntElementEx​

int VRSetPropertyIntElementEx(
    HNode node,
    uint32_t prop,
    size_t index,
    int value,
    uint32_t flags,
    int userChange
)

Sets an element in a INT array property on a node.

Parameters:

  • index element to set (0-based array index)
  • value value to set

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyIntEx​

int VRSetPropertyIntEx(
    HNode node,
    uint32_t prop,
    int value,
    uint32_t flags,
    int userChange
)

Sets an INT property on a node.

Parameters:

  • value value to set

See: VRSetPropertyValueEx()

Return: 0 on success

int VRSetPropertyLink(
    HNode node,
    const char * propName,
    HNode linkTarget
)

Sets a LINK property on a node.

Parameters:

  • linkTarget value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyLinkEx​

int VRSetPropertyLinkEx(
    HNode node,
    uint32_t prop,
    HNode linkTarget,
    uint32_t flags,
    int userChange
)

Sets a LINK property on a node.

Parameters:

  • linkTarget value to set

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyString​

int VRSetPropertyString(
    HNode node,
    const char * propName,
    const char * stringData
)

Sets a STRING property on a node.

Parameters:

  • stringData value to set

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyStringElement​

int VRSetPropertyStringElement(
    HNode node,
    const char * propName,
    size_t index,
    const char * value,
    size_t valueSize
)

Sets an element in a STRING array property on a node.

Parameters:

  • index element to set (0-based array index)
  • value value to set
  • valueSize the size of the size

See: VRSetPropertyValue()

Return: 0 on success

VRSetPropertyStringElementEx​

int VRSetPropertyStringElementEx(
    HNode node,
    uint32_t prop,
    size_t index,
    const char * values,
    size_t arraySize,
    uint32_t flags,
    int userChange
)

Sets an element in a STRING array property on a node.

Parameters:

  • index element to set (0-based array index)
  • values values to set
  • arraySize the size of the values array

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyStringEx​

int VRSetPropertyStringEx(
    HNode node,
    uint32_t prop,
    const char * stringData,
    uint32_t flags,
    int userChange
)

Sets a STRING property on a node.

Parameters:

  • stringData value to set

See: VRSetPropertyValueEx()

Return: 0 on success

VRSetPropertyValue​

int VRSetPropertyValue(
    HNode node,
    const char * propName,
    const void * valueData,
    size_t valueSize
)

Sets a property value on a node.

Parameters:

  • node handle to the node to set value on
  • propName the name of the property to set
  • buffer of data to set as the property value
  • size of the buffer

Return: 0 if property was set successfully

VRSetPropertyValueEx​

int VRSetPropertyValueEx(
    HNode node,
    uint32_t prop,
    const void * valueData,
    size_t valueSize,
    uint32_t flags,
    int userChange
)

Sets a property value on a node.

Parameters:

  • node handle to the node to set value on
  • prop the index of the property to set
  • buffer of data to set as the property value
  • size of the buffer
  • flags flags to use during property setting
  • userChange whether the property change is the result of user action

Return: 0 on success