H3D::SFieldClass Class Reference

Base class for all fields created with the SField template. More...

#include <SField.h>

Inheritance diagram for H3D::SFieldClass:

Inheritance graph
List of all members.

Public Member Functions

virtual int setValueFromVoidPtr (void *data, unsigned int size, int id=0)=0
 Set the value of the field given a pointer to where the value of the field is.
virtual int getValueAsVoidPtr (void *data, unsigned int size, int id=0)=0
 Get the value of the data copied into a memory buffer.
virtual unsigned int valueTypeSize ()=0
 Returns the size in bytes of the value type the sfield encapsulates.

Detailed Description

Base class for all fields created with the SField template.


Member Function Documentation

virtual int H3D::SFieldClass::getValueAsVoidPtr void *  data,
unsigned int  size,
int  id = 0
[pure virtual]
 

Get the value of the data copied into a memory buffer.

Parameters:
data Buffer to copy the data into.
size The size of the buffer.
Returns:
If successful: The number of bytes that was copied into the Otherwise -1.

Implemented in H3D::SField< Type >, H3D::SField< RGB >, H3D::SField< RGBA >, H3D::SField< Matrix3d >, H3D::SField< Matrix4d >, H3D::SField< H3DFloat >, H3D::SField< string >, H3D::SField< Matrix3f >, H3D::SField< Matrix4f >, H3D::SField< Vec2f >, H3D::SField< Vec3f >, H3D::SField< bool >, H3D::SField< Vec2d >, H3D::SField< Vec4f >, H3D::SField< H3DDouble >, H3D::SField< Vec3d >, H3D::SField< Vec4d >, H3D::SField< Quaternion >, H3D::SField< H3DInt32 >, and H3D::SField< Rotation >.

virtual int H3D::SFieldClass::setValueFromVoidPtr void *  data,
unsigned int  size,
int  id = 0
[pure virtual]
 

Set the value of the field given a pointer to where the value of the field is.

Parameters:
data A pointer to the data.
size The size in bytes of the value stored in data.
Returns:
0 if successful, -1 otherwise.

Implemented in H3D::SField< Type >, H3D::SField< RGB >, H3D::SField< RGBA >, H3D::SField< Matrix3d >, H3D::SField< Matrix4d >, H3D::SField< H3DFloat >, H3D::SField< string >, H3D::SField< Matrix3f >, H3D::SField< Matrix4f >, H3D::SField< Vec2f >, H3D::SField< Vec3f >, H3D::SField< bool >, H3D::SField< Vec2d >, H3D::SField< Vec4f >, H3D::SField< H3DDouble >, H3D::SField< Vec3d >, H3D::SField< Vec4d >, H3D::SField< Quaternion >, H3D::SField< H3DInt32 >, and H3D::SField< Rotation >.


Generated on Thu Aug 24 12:39:53 2006 for H3D API by  doxygen 1.4.5