Properties

Functions for managing Properties on metanodes.

Functions


int VRAddPropertyArrayBool(HMeta metaNode,
const char * propertyName,
int num,
char defaultValue
)

Adds an arbitrarily sized boolean array property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

num

number of elements in the array

defaultValue

default value to use in each element on new nodes


int VRAddPropertyArrayChar(HMeta metaNode,
const char * propertyName,
int num,
char defaultValue
)

Adds an arbitrarily sized character array property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

num

number of elements in the array

defaultValue

default value to use in each element on new nodes


int VRAddPropertyArrayDouble(HMeta metaNode,
const char * propertyName,
int num,
double defaultValue
)

Adds an arbitrarily sized double array property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

num

number of elements in the array

defaultValue

default value to use in each element on new nodes


int VRAddPropertyArrayFloat(HMeta metaNode,
const char * propertyName,
int num,
float defaultValue
)

Adds an arbitrarily sized float array property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

num

number of elements in the array

defaultValue

default value to use in each element on new nodes


int VRAddPropertyArrayInt(HMeta metaNode,
const char * propertyName,
int num,
int defaultValue
)

Adds an arbitrarily sized integer array property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

num

number of elements in the array

defaultValue

default value to use in each element on new nodes


int VRAddPropertyArrayWorldFloat(HMeta metaNode,
const char * propertyName,
int num,
double defaultValue
)

Adds an arbitrarily sized world float array property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

num

number of elements in the array

defaultValue

default value to use in each element on new nodes


int VRAddPropertyBool(HMeta metaNode,
const char * propertyName,
char defaultValue
)

Adds a boolean property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes (truncated to 0 or 1)

Returns

0 if the property is added successfully


int VRAddPropertyChar(HMeta metaNode,
const char * propertyName,
char defaultValue
)

Adds a char property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyCharRange(HMeta metaNode,
const char * propertyName,
char defaultValue,
char minValue,
char maxValue
)

Adds a char property to a metanode with min/max range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes

minValue

the minimum value hint

maxValue

the maximum value hint

Returns

0 if the property is added successfully


int VRAddPropertyDouble(HMeta metaNode,
const char * propertyName,
double defaultValue
)

Adds a double property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyDoubleRange(HMeta metaNode,
const char * propertyName,
double defaultValue,
double minValue,
double maxValue
)

Adds a double property to a metanode, with min/max range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes

minValue

the minimum value hint

maxValue

the maximum value hint

Returns

0 if the property is added successfully


int VRAddPropertyFile(HMeta metaNode,
const char * propertyName,
const char * fileFilter
)

Adds a file property to a metanode with a file filter of allowed types.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

fileFilter

adds a filter semantic to the property allowing file dialogs to filter files

Returns

0 if the property is added successfully


int VRAddPropertyFloat(HMeta metaNode,
const char * propertyName,
float defaultValue
)

Adds a float property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyFloatRange(HMeta metaNode,
const char * propertyName,
float defaultValue,
float minValue,
float maxValue
)

Adds a float property to a metanode, with min/max range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes

minValue

the minimum value hint

maxValue

the maximum value hint

Returns

0 if the property is added successfully


int VRAddPropertyInt(HMeta metaNode,
const char * propertyName,
int defaultValue
)

Adds an integer property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyIntRange(HMeta metaNode,
const char * propertyName,
int defaultValue,
int minValue,
int maxValue
)

Adds an integer property to a metanode, with min/max range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes

minValue

the minimum value hint

maxValue

the maximum value hint

Returns

0 if the property is added successfully


int VRAddPropertyIntType(HMeta metaNode,
const char * propertyName,
int defaultValue,
const char * type
)

Adds an integer property to a metanode, with min/max range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes

type

the Meta_PropSemantics::PropType to set

Returns

0 if the property is added successfully


int VRAddPropertyLink(HMeta metaNode,
const char * propertyName
)

Adds a link property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyLinkFilter(HMeta metaNode,
const char * propertyName,
const char * linkFilter
)

Adds a link property to a metanode with a filter on allowed types.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

linkFilter

comma separated list of metanodes or traits that are allowed to be linked to

Returns

0 if the property is added successfully


int VRAddPropertyMat3d(HMeta metaNode,
const char * propertyName
)

Adds a 3x3 double matrix property to a metanode. Default value is an identity matrix.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyMat3f(HMeta metaNode,
const char * propertyName
)

Adds a 3x3 float matrix property to a metanode. Default value is an identity matrix.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyMat3w(HMeta metaNode,
const char * propertyName
)

Adds a 3x3 world float matrix property to a metanode. Default value is an identity matrix.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyMat4d(HMeta metaNode,
const char * propertyName
)

Adds a 4x4 double matrix property to a metanode. Default value is an identity matrix.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyMat4f(HMeta metaNode,
const char * propertyName
)

Adds a 4x4 float matrix property to a metanode. Default value is an identity matrix.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyMat4w(HMeta metaNode,
const char * propertyName
)

Adds a 4x4 world float matrix property to a metanode. Default value is an identity matrix.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyMat4w2D(HMeta metaNode,
const char * propertyName
)

Adds a 4x4 world float matrix property to a metanode, with a prop semantic specifying that a 2D matrix editing control should be used for it (e.g. a texture map matrix). Default value is an identity matrix.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyRGB(HMeta metaNode,
const char * propertyName,
float defaultR,
float defaultG,
float defaultB
)

Adds an RGB colour property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultR

the default value of the red element on new nodes

defaultG

the default value of the green element on new nodes

defaultB

the default value of the blue element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyRGBA(HMeta metaNode,
const char * propertyName,
float defaultR,
float defaultG,
float defaultB,
float defaultA
)

Adds an RGBA colour property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultR

the default value of the red element on new nodes

defaultG

the default value of the green element on new nodes

defaultB

the default value of the blue element on new nodes

defaultA

the default value of the alpha element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertySphere(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double defaultZ,
double defaultR
)

Adds a sphere property to a metanode. Defaults are specified as double and truncated to float if the world float type is single precision.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the position element's x value on new nodes

defaultY

the default value of the position element's y value on new nodes

defaultZ

the default value of the position element's z value on new nodes

defaultR

the default value of the radius element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyStream(HMeta metaNode,
const char * propertyName,
const char * fileFilter
)

Adds a stream property to a metanode with a file filter of allowed types.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

fileFilter

adds a filter semantic to the property allowing file dialogs to filter files

Returns

0 if the property is added successfully


int VRAddPropertyString(HMeta metaNode,
const char * propertyName
)

Adds a string property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyStringEx(HMeta metaNode,
const char * propertyName,
const char * defaultValue
)

Adds a string property to a metanode with a default string value.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the string to use as the default on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyStringType(HMeta metaNode,
const char * propertyName,
const char * type
)

Adds a string property to a metanode with a default string value.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

type

the Meta_PropSemantics::PropType to set

Returns

0 if the property is added successfully


int VRAddPropertyVec2d(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY
)

Adds a double vec2 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec2dRange(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double minX,
double minY,
double maxX,
double maxY
)

Adds a double vec2 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec2f(HMeta metaNode,
const char * propertyName,
float defaultX,
float defaultY
)

Adds a float vec2 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec2fRange(HMeta metaNode,
const char * propertyName,
float defaultX,
float defaultY,
float minX,
float minY,
float maxX,
float maxY
)

Adds a float vec2 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec2i(HMeta metaNode,
const char * propertyName,
int defaultX,
int defaultY
)

Adds an integer vec2 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec2iRange(HMeta metaNode,
const char * propertyName,
int defaultX,
int defaultY,
int minX,
int minY,
int maxX,
int maxY
)

Adds an integer vec2 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec2w(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY
)

Adds a world float vec2 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec2wRange(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double minX,
double minY,
double maxX,
double maxY
)

Adds a world float vec2 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec3d(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double defaultZ
)

Adds a double vec3 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec3dRange(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double defaultZ,
double minX,
double minY,
double minZ,
double maxX,
double maxY,
double maxZ
)

Adds a double vec3 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

minZ

the min value of the z element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

maxZ

the max value of the z element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec3f(HMeta metaNode,
const char * propertyName,
float defaultX,
float defaultY,
float defaultZ
)

Adds a float vec3 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec3fRange(HMeta metaNode,
const char * propertyName,
float defaultX,
float defaultY,
float defaultZ,
float minX,
float minY,
float minZ,
float maxX,
float maxY,
float maxZ
)

Adds a float vec3 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

minZ

the min value of the z element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

maxZ

the max value of the z element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec3i(HMeta metaNode,
const char * propertyName,
int defaultX,
int defaultY,
int defaultZ
)

Adds an integer vec3 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec3iRange(HMeta metaNode,
const char * propertyName,
int defaultX,
int defaultY,
int defaultZ,
int minX,
int minY,
int minZ,
int maxX,
int maxY,
int maxZ
)

Adds an integer vec3 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

minZ

the min value of the z element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

maxZ

the max value of the z element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec3w(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double defaultZ
)

Adds a world float vec3 property to a metanode. Defaults are specified as double and truncated to float if the world float type is single precision.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec3wRange(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double defaultZ,
double minX,
double minY,
double minZ,
double maxX,
double maxY,
double maxZ
)

Adds a world float vec3 property to a metanode with range hints Defaults and range are specified as double and truncated to float if the world float type is single precision.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

minZ

the min value of the z element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

maxZ

the max value of the z element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec4d(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double defaultZ,
double defaultW
)

Adds a double vec4 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

defaultW

the default value of the w element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec4dRange(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double defaultZ,
double defaultW,
double minX,
double minY,
double minZ,
double minW,
double maxX,
double maxY,
double maxZ,
double maxW
)

Adds a double vec4 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

defaultW

the default value of the w element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

minZ

the min value of the z element on new nodes

minW

the min value of the w element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

maxZ

the max value of the z element on new nodes

maxW

the max value of the w element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec4f(HMeta metaNode,
const char * propertyName,
float defaultX,
float defaultY,
float defaultZ,
float defaultW
)

Adds a float vec4 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

defaultW

the default value of the w element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec4fRange(HMeta metaNode,
const char * propertyName,
float defaultX,
float defaultY,
float defaultZ,
float defaultW,
float minX,
float minY,
float minZ,
float minW,
float maxX,
float maxY,
float maxZ,
float maxW
)

Adds a float vec4 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

defaultW

the default value of the w element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

minZ

the min value of the z element on new nodes

minW

the min value of the w element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

maxZ

the max value of the z element on new nodes

maxW

the max value of the w element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec4i(HMeta metaNode,
const char * propertyName,
int defaultX,
int defaultY,
int defaultZ,
int defaultW
)

Adds an integer vec4 property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

defaultW

the default value of the w element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec4iRange(HMeta metaNode,
const char * propertyName,
int defaultX,
int defaultY,
int defaultZ,
int defaultW,
int minX,
int minY,
int minZ,
int minW,
int maxX,
int maxY,
int maxZ,
int maxW
)

Adds an integer vec4 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

defaultW

the default value of the w element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

minZ

the min value of the z element on new nodes

minW

the min value of the w element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

maxZ

the max value of the z element on new nodes

maxW

the max value of the w element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec4w(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double defaultZ,
double defaultW
)

Adds a world float vec4 property to a metanode. Defaults are specified as double and truncated to float if the world float type is single precision.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

defaultW

the default value of the w element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVec4wRange(HMeta metaNode,
const char * propertyName,
double defaultX,
double defaultY,
double defaultZ,
double defaultW,
double minX,
double minY,
double minZ,
double minW,
double maxX,
double maxY,
double maxZ,
double maxW
)

Adds a world float vec4 property to a metanode with range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultX

the default value of the x element on new nodes

defaultY

the default value of the y element on new nodes

defaultZ

the default value of the z element on new nodes

defaultW

the default value of the w element on new nodes

minX

the min value of the x element on new nodes

minY

the min value of the y element on new nodes

minZ

the min value of the z element on new nodes

minW

the min value of the w element on new nodes

maxX

the max value of the x element on new nodes

maxY

the max value of the y element on new nodes

maxZ

the max value of the z element on new nodes

maxW

the max value of the w element on new nodes

Returns

0 if the property is added successfully


int VRAddPropertyVectorChar(HMeta metaNode,
const char * propertyName
)

Adds a character vector property to a metanode (resizable container)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyVectorFloat(HMeta metaNode,
const char * propertyName
)

Adds a float vector property to a metanode (resizable container)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyVectorInt(HMeta metaNode,
const char * propertyName
)

Adds an integer vector property to a metanode (resizable container)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyVectorString(HMeta metaNode,
const char * propertyName
)

Adds a string vector property to a metanode (resizable container)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyVectorWorldFloat(HMeta metaNode,
const char * propertyName
)

Adds a world float vector property to a metanode (resizable container)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

Returns

0 if the property is added successfully


int VRAddPropertyWorldFloat(HMeta metaNode,
const char * propertyName,
double defaultValue
)

Adds a world float property to a metanode.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes. Truncated according to world precision.

Returns

0 if the property is added successfully


int VRAddPropertyWorldFloatRange(HMeta metaNode,
const char * propertyName,
double defaultValue,
double minValue,
double maxValue
)

Adds a world float property to a metanode, with min/max range hints.

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to add

defaultValue

the default value on new nodes. Truncated according to world precision.

minValue

the minimum value hint, truncated according to world precision

maxValue

the maximum value hint, truncated according to world precision

Returns

0 if the property is added successfully


Gets the number of properties on a metanode.

Parameters
metaNode

handle to the metanode to query

Returns

the number of properties on the metanode, or -1 on error (0 is a valid number of properties)


int VRSetPropertyCached(HMeta metaNode,
const char * propertyName,
char cached
)

Sets a property as cached (contents are replicated in the disk cache)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to modify

cached

any value greater than 0 makes the property cached

Returns

0 if property is successfully changed


int VRSetPropertyCloned(HMeta metaNode,
const char * propertyName,
char saved
)

Sets a property as cloned (whether the property value should be copied when cloning a node)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to modify

saved

any value greater than 0 makes the property saved

Returns

0 if property is successfully changed


int VRSetPropertyInternal(HMeta metaNode,
const char * propertyName,
char internal
)

Sets a property as internal (provides a hint to node property user interface to not display the property editor)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to modify

internal

any value greater than 0 makes the property internal

Returns

0 if property is successfully changed


int VRSetPropertyPurged(HMeta metaNode,
const char * propertyName,
char purged
)

Sets a property as purged (contents are ejected from memory and cached to disk)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to modify

purged

any value greater than 0 makes the property purged

Returns

0 if property is successfully changed


int VRSetPropertyReadOnly(HMeta metaNode,
const char * propertyName,
char readOnly
)

Sets a property as read-only (provides a hint to node property user interface to make the editor read only)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to modify

readOnly

any value greater than 0 makes the property read only

Returns

0 if property is successfully changed


int VRSetPropertySaved(HMeta metaNode,
const char * propertyName,
char saved
)

Sets a property as saved (whether or not the value is saved to VRText/VRNative documents)

Parameters
metaNode

handle to the metanode to modify

propertyName

name of the property to modify

saved

any value greater than 0 makes the property saved

Returns

0 if property is successfully changed

No Results.

Getting StartedArchitectureBest PracticesHow ToAdvanced TopicsChangelogvrtree_cppCoreForeign Function InterfaceMetanodesMigrationsObserversPropertiesTreeUtilitiesAPI DefinitionsVR ExchangePluginsLua API