Provides script language access to C++ objects of this type.
| Class Hierarchy | Type » DataCapture |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| <DataCapture> | DataCapture | The <DataCapture> constructor which allows you to set this object's <Node> container. ( The <Node> in which the <DataCapture> object is resident. ) |
| int32 | Clear | Clears the internal <NodeSelector>, Local Data Source &tl;NodeSink>, data acquisition string value, and container object pointer. |
| <DataCapture> | Clone | Returns a pointer to a new <DataCapture> object. |
| <Node> | FindDataSource | Gets the <Node> data source from which the <DataCapture> object is capturing data. For example <LightDataCaptureAmbientColor> captures data from <Light> objects, and this function returns the <Light> object from which data is being captured. This <Light> object can be in the same document as the <DataCapture> object, in which case this function returns the <Light> directly via the <DataCapture> object's <NodeSink> object, or the <Light> object can be stored in a remote document, in which case this function gets the <Light> object from the <DataCapture> object's <NodeSelector> object. |
| <Int32Array> | GetBooleanArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <BooleanArrayDataCapture> ), returns a pointer to the <Int32Array> data member of this object. Otherwise returns nullptr. |
| int32 | GetBooleanValue | Returns the Boolean value being stored by the <DataCapture> object. |
| <Int32VectorArray> | GetBooleanVectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <BooleanVectorArrayDataCapture> ), returns a pointer to the <Int32VectorArray> data member of this object. Otherwise returns nullptr. |
| <Int32Vector> | GetBooleanVectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <BooleanVectorDataCapture> ), returns a pointer to the <Int32Vector> data member of this object. Otherwise returns nullptr. |
| TypeInformation | GetCaptureTargetType | Returns a <TypeInformation> object that indicates the type of object from which the <DataCapture> object can capture data. For example: LightDataCaptureAmbientColor returns <Light>. The LightDataCaptureAmbientColor data capture object can only capture data from objects of type <Light>. |
| int32 | GetCaptureTargetTypes | Populates a <TypeInfoArray> with auxiliary types from which a <DataCapture> object can capture data. |
| <ColorArray> | GetColorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <ColorArrayDataCapture> ), returns a pointer to the <ColorArray> data member of this object. Otherwise returns nullptr. |
| <Color> | GetColorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <ColorDataCapture> ), returns a pointer to the <Color> data member of this object. Otherwise returns nullptr. |
| TypeInformation | GetContainerVariableType | Returns a pointer to a <TypeInformation> object representing the relevant <VariableNode>-derived class. For example: LightDataCaptureAmbientColor object returns <ColorNode> and <MaterialDataCaptureShininess> returns <Float32Node>. |
| int32 | GetContainerVariableTypes | Populates a <TypeInfoArray> with any valid container object types. |
| string | GetDestinationName | Gets a string containing the destination name for the data capture operation. For example: LightDataCaptureAmbientColor returns "lightAmbientColor", which is used to set variable names for <ColorNode> objects that use this data capture object. This provides a means by which data capture state can be applied consistently. |
| int32 | GetDimension | Gets the dimension of the <DataCapture> object. For example: GLSL_Float, GLSL_Mat4x4. |
| <Float16Array> | GetFloat16ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float16ArrayDataCapture ), returns a pointer to the <Float16Array> data member of this object. Otherwise returns nullptr. |
| float | GetFloat16Value | Returns the value of this object. |
| <Float16VectorArray> | GetFloat16VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float16VectorArrayDataCapture ), returns a pointer to the <Float16VectorArray> data member of this object. Otherwise returns nullptr. |
| <Float16Vector> | GetFloat16VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float16VectorDataCapture ), returns a pointer to the <Float16Vector> data member of this object. Otherwise returns nullptr. |
| <Float32Array> | GetFloat32ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float32ArrayDataCapture ), returns a pointer to the <Float32Array> data member of this object. Otherwise returns nullptr. |
| <Float32MatrixArray> | GetFloat32MatrixArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float32MatrixArrayDataCapture ), returns a pointer to the <Float32MatrixArray> data member of this object. Otherwise returns nullptr. |
| <Float32Matrix> | GetFloat32MatrixValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float32MatrixDataCapture> ), returns a pointer to the <Float32Matrix> data member of this object. Otherwise returns nullptr. |
| float | GetFloat32Value | Returns the <float32> value being stored by the <DataCapture> object. |
| <Float32VectorArray> | GetFloat32VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float32VectorArrayDataCapture> ), returns a pointer to the <Float32VectorArray> data member of this object. Otherwise returns nullptr. |
| <Float32Vector> | GetFloat32VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float32VectorDataCapture> ), returns a pointer to the <Float32Vector> data member of this object. Otherwise returns nullptr. |
| <Float64Array> | GetFloat64ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float64ArrayDataCapture> ), returns a pointer to the <Float64Array> data member of this object. Otherwise returns nullptr. |
| <Float64MatrixArray> | GetFloat64MatrixArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float64MatrixArrayDataCapture> ), returns a pointer to the <Float64MatrixArray> data member of this object. Otherwise returns nullptr. |
| <Float64Matrix> | GetFloat64MatrixValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float64MatrixDataCapture> ), returns a pointer to the <Float64Matrix> data member of this object. Otherwise returns nullptr. |
| double | GetFloat64Value | Returns the <float64> value being stored by the <DataCapture> object. |
| <Float64VectorArray> | GetFloat64VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float64VectorArrayDataCapture> ), returns a pointer to the <Float64VectorArray> data member of this object. Otherwise returns nullptr. |
| <Float64Vector> | GetFloat64VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Float64VectorDataCapture> ), returns a pointer to the <Float64Vector> data member of this object. Otherwise returns nullptr. |
| <Int16Array> | GetInt16ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int16ArrayDataCapture ), returns a pointer to the <Int16Array> data member of this object. Otherwise returns nullptr. |
| int32 | GetInt16Value | Returns the value of this object. |
| <Int16VectorArray> | GetInt16VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int16VectorArrayDataCapture ), returns a pointer to the <Int16VectorArray> data member of this object. Otherwise returns nullptr. |
| <Int16Vector> | GetInt16VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int16VectorDataCapture ), returns a pointer to the <Int16Vector> data member of this object. Otherwise returns nullptr. |
| <Int32Array> | GetInt32ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int32ArrayDataCapture> ), returns a pointer to the <Int32Array> data member of this object. Otherwise returns nullptr. |
| int32 | GetInt32Value | Returns the <int32> value being stored by the <DataCapture> object. |
| <Int32VectorArray> | GetInt32VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int32VectorArrayDataCapture> ), returns a pointer to the <Int32VectorArray> data member of this object. Otherwise returns nullptr. |
| <Int32Vector> | GetInt32VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int32VectorDataCapture> ), returns a pointer to the <Int32Vector> data member of this object. Otherwise returns nullptr. |
| <Int64Array> | GetInt64ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int64ArrayDataCapture> ), returns a pointer to the <Int64Array> data member of this object. Otherwise returns nullptr. |
| int64 | GetInt64Value | Returns the <int64> value being stored by the <DataCapture> object. |
| <Int64VectorArray> | GetInt64VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int64VectorArrayDataCapture> ), returns a pointer to the <Int64VectorArray> data member of this object. Otherwise returns nullptr. |
| <Int64Vector> | GetInt64VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int64VectorDataCapture> ), returns a pointer to the <Int64Vector> data member of this object. Otherwise returns nullptr. |
| <Int8Array> | GetInt8ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int8ArrayDataCapture ), returns a pointer to the <Int8Array> data member of this object. Otherwise returns nullptr. |
| int32 | GetInt8Value | Returns the value of this object. |
| <Int8VectorArray> | GetInt8VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int8VectorArrayDataCapture ), returns a pointer to the <Int8VectorArray> data member of this object. Otherwise returns nullptr. |
| <Int8Vector> | GetInt8VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Int8VectorDataCapture ), returns a pointer to the <Int8Vector> data member of this object. Otherwise returns nullptr. |
| <MatrixArray> | GetMatrixArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from MatrixArrayDataCapture> ), returns a pointer to the MatrixArray> data member of this object. Otherwise returns nullptr. |
| <Matrix> | GetMatrixValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from MatrixDataCapture> ), returns a pointer to the <Matrix> data member of this object. Otherwise returns nullptr. |
| int32 | GetPackedObjects | Populates a <List> with all <DataCapture> objects stored by a particular <DataCapture> package. For example: a <VectorDataCapturePackage> object ( which is a subclass of <DataCapture> ) may contain up to four <Float32DataCapture> objects, and a <MatrixDataCapturePackage> may contain up to four <VectorDataCapturePackage> objects, each of which can contain up to four <Float32DataCapture> objects. This function populates the <List> with all <DataCapture> objects in the package or set of packages. |
| string | GetSourceName | Gets a string containing the destination name for the data capture operation. For example: <LightDataCaptureAmbientColor> returns "SPA_LightAmbientColor", which is used to indicate data capture state in a way that cannot be modified by an end user. If the user overrides a particular name such as 'lightAmbientColor', the underlying data capture operation can still be tracked. This provides a means by which data capture state can be applied consistently, which is especially important for algorithms running on sets of <DataCapture> objects. |
| <TextureReadbackParams> | GetTextureReadbackParams | Returns a pointer to the <DataCapture> object's <TextureReadbackParams> data member, or nullptr if the <DataCapture> data member does not exist. |
| <Uint16Array> | GetUint16ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Uint16ArrayDataCapture ), returns a pointer to the <Uint16Array> data member of this object. Otherwise returns nullptr. |
| uint32 | GetUint16Value | Returns the value of this object. |
| <Uint16VectorArray> | GetUint16VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Uint16VectorArrayDataCapture ), returns a pointer to the <Uint16VectorArray> data member of this object. Otherwise returns nullptr. |
| <Uint16Vector> | GetUint16VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Uint16VectorDataCapture ), returns a pointer to the <Uint16Vector> data member of this object. Otherwise returns nullptr. |
| <Uint32Array> | GetUint32ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Uint32ArrayDataCapture> ), returns a pointer to the <Uint32Array> data member of this object. Otherwise returns nullptr. |
| uint32 | GetUint32Value | Returns the <uint32> value being stored by the <DataCapture> object. |
| <Uint32VectorArray> | GetUint32VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from UintVectorArrayDataCapture> ), returns a pointer to the <Uint32VectorArray> data member of this object. Otherwise returns nullptr. |
| <Uint32Vector> | GetUint32VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Uint32VectorDataCapture> ), returns a pointer to the <Uint32Vector> data member of this object. Otherwise returns nullptr. |
| <Uint64Array> | GetUint64ArrayValue | Returns the <uint64> array value being stored by the <DataCapture> object. |
| uint64 | GetUint64Value | Returns the <uint64> value being stored by the <DataCapture> object. |
| <Uint64VectorArray> | GetUint64VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Uint64VectorArrayDataCapture> ), returns a pointer to the <Uint64VectorArray> data member of this object. Otherwise returns nullptr. |
| <Uint64Vector> | GetUint64VectorValue | Returns the <uint64> vector value being stored by the <DataCapture> object. |
| <Uint8Array> | GetUint8ArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Uint8ArrayDataCapture ), returns a pointer to the <Uint8Array> data member of this object. Otherwise returns nullptr. |
| uint32 | GetUint8Value | Returns the value of this object. |
| <Uint8VectorArray> | GetUint8VectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Uint8VectorArrayDataCapture ), returns a pointer to the <Uint8VectorArray> data member of this object. Otherwise returns nullptr. |
| <Uint8Vector> | GetUint8VectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <Uint8VectorDataCapture ), returns a pointer to the <Uint8Vector> data member of this object. Otherwise returns nullptr. |
| string | GetValueString | Returns the value string, such as 'false' or '{ 1, 0, 0, 1}' or similar. This string is guaranteed to be parseable. |
| <Float64VectorArray> | GetVectorArrayValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <VectorArrayDataCapture> ), returns a pointer to the <Float64VectorArray> data member of this object. Otherwise returns nullptr. |
| <Float64Vector> | GetVectorValue | If the <DataCapture> object is a pointer to a compatible and relevant derived class ( such as any class derived from <VectorDataCapture> ), returns a pointer to the <Float64Vector> data member of this object. Otherwise returns nullptr. |
| int32 | GetViewFromObject | Copies <DataCapture> dimension information into the <MemberView> object parameter. For example, <LightDataCaptureNearX> is a <Float32DataCapture> object. The resulting <MemberView> object will return 1 and 1 for its rows and columns when queried. Similarly, a <LightDataCapturePosition> is a <Float32VectorDataCapture< object. The resulting <MemberView> object will return 1 and 1 for its rows and columns when queried. <Float32MatrixDataCapture> objects might return row and column counts such as 3 and 3 or 4 and 4. |
| int32 | IsArrayType | Returns true if and only if the <DataCapture> object represents arrays such as <BooleanArrayDataCapture>, <Float32VectorArrayDataCapture, or <MatrixArrayDataCapture>. |
| int32 | IsBoolType | Returns true if and only if the <DataCapture> object represents a Boolean type. |
| int32 | IsColorType | Returns true if and only if the <DataCapture> object represents a Color type. |
| int32 | IsFloat16Type | Returns true if and only if the <DataCapture> object represents a <float32> type. |
| int32 | IsFloat32Type | Returns true if and only if the <DataCapture> object represents a <float32> type. |
| int32 | IsFloat64Type | Returns true if and only if the <DataCapture> object represents a <float64> type. |
| int32 | IsFloatType | Returns true if and only if the <DataCapture> object represents any floating point type (16,32, or 64 bit) type. |
| int32 | IsInt16Type | Returns true if and only if the <DataCapture> object represents an <int16> type. |
| int32 | IsInt32Type | Returns true if and only if the <DataCapture> object represents an <int32> type. |
| int32 | IsInt64Type | Returns true if and only if the <DataCapture> object represents an <int64> type. |
| int32 | IsInt8Type | Returns true if and only if the <DataCapture> object represents an <int8> type. |
| int32 | IsIntegralType | Returns true if and only if the <DataCapture> object represents an integral type. |
| int32 | IsMatrixArrayType | Returns true if and only if the <DataCapture> object represents a matrix array type. |
| int32 | IsMatrixType | Returns true if and only if the <DataCapture> object represents a matrix type. |
| int32 | IsScalarArrayType | Returns true if and only if the <DataCapture> object represents an array of scalar types. |
| int32 | IsScalarType | Returns true if and only if the <DataCapture> object represents a scalar type. |
| int32 | IsUint16Type | Returns true if and only if the <DataCapture> object represents a <uint16> type. |
| int32 | IsUint32Type | Returns true if and only if the <DataCapture> object represents a <uint32> type. |
| int32 | IsUint64Type | Returns true if and only if the <DataCapture> object represents a <uint64> type. |
| int32 | IsUint8Type | Returns true if and only if the <DataCapture> object represents an <uint8> type. |
| int32 | IsValueCaptureType | Returns true if and only if the <DataCapture> object represents a value capture type such as <Float32DataCaptureScalar>, <Float32DataCaptureArray>, <Float32VectorDataCaptureVector>, or <Float32VectorArrayDataCaptureArray>. |
| int32 | IsVectorArrayType | Returns true if and only if the <DataCapture> object represents an array of vectors. |
| int32 | IsVectorType | Returns true if and only if the <DataCapture> object represents a vector type. |
| int32 | SetBooleanValue | Sets the value of this object. |
| int32 | SetFloat16Value | Sets the value of this object. |
| int32 | SetFloat32Value | Sets the value of this object. |
| int64 | SetFloat64Value | Sets the value of this object. |
| int32 | SetInt16Value | Sets the value of this object. |
| int32 | SetInt32Value | Sets the value of this object. |
| int64 | SetInt64Value | Sets the value of this object. |
| int32 | SetInt8Value | Sets the value of this object. |
| int32 | SetObjectParametersFromView | Configures the the <DataCapture> object's data members, array count, vector dimension, or matrix dimensions, etc. with the parameters stored in the <MemberView> object submitted to this function. |
| int32 | SetUint16Value | Sets the value of this object. |
| uint32 | SetUint32Value | Sets the value of this object. |
| uint64 | SetUint64Value | Sets the value of this object. |
| int32 | SetUint8Value | Sets the value of this object. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| <Node> | Container | Gets or sets this object's container object, which is the <Node> in which the <DataCapture> object is resident. Get returns a <Node> pointer and Set requires a <Node> pointer. |
| <Node> | ContainerLink | Gets or sets this object's container object. |
| <DataCaptureIndices> | DataCaptureIndices | Returns a pointer to this object's <DataCaptureIndices> object. |
| <DataCaptureList> | DataCaptureList | Returns a pointer to the <DataCaptureList> object if the <DataCapture> object or subclass can store sub-objects. Otherwise returns nullptr. This object enables you to nest <DataCapture> objects inside other <DataCapture> objects. For example: A <DataCapture> object may be stored in a <VariableNode> representing an array, such as <Float32ArrayNode>, and <DataCapture> sub-objects stored in this <DataCaptureList> may set individual array values. |
| <Node> | LocalDataSource | Gets or sets the local data source, which is the object from which you wish to capture data. |
| <Node> | LocalDataSourceLink | Gets or sets the local data source, which is the object from which you wish to capture data. |
| string | Name | Gets or sets the name associated with the <DataCapture> object. This is usually used to associate a GLSL or SSL variable declaration with a <DataCapture> object, but it can be used to differentiate <DataCapture> objects from one another. |