---

RpUserData
[Scene Management]

Data Structures
struct	RpUserDataArray
Enumerations
enum	RpUserDataFormat {   rpNAUSERDATAFORMAT = 0, rpINTUSERDATA, rpREALUSERDATA, rpSTRINGUSERDATA,   rpUSERDATAFORCEENUMSIZEINT = RWFORCEENUMSIZEINT }
Functions
RwInt32	RpGeometryAddUserDataArray (RpGeometry *geometry, RwChar *name, RpUserDataFormat format, RwInt32 numElements)
RpGeometry *	RpGeometryRemoveUserDataArray (RpGeometry *geometry, RwInt32 index)
RwInt32	RpGeometryGetUserDataArrayCount (const RpGeometry *geometry)
RpUserDataArray *	RpGeometryGetUserDataArray (const RpGeometry *geometry, RwInt32 data)
RwInt32	RpWorldSectorAddUserDataArray (RpWorldSector *sector, RwChar *name, RpUserDataFormat format, RwInt32 numElements)
RpWorldSector *	RpWorldSectorRemoveUserDataArray (RpWorldSector *sector, RwInt32 index)
RwInt32	RpWorldSectorGetUserDataArrayCount (const RpWorldSector *sector)
RpUserDataArray *	RpWorldSectorGetUserDataArray (const RpWorldSector *sector, RwInt32 data)
RwInt32	RwFrameAddUserDataArray (RwFrame *frame, RwChar *name, RpUserDataFormat format, RwInt32 numElements)
RwFrame *	RwFrameRemoveUserDataArray (RwFrame *frame, RwInt32 index)
RwInt32	RwFrameGetUserDataArrayCount (const RwFrame *frame)
RpUserDataArray *	RwFrameGetUserDataArray (const RwFrame *frame, RwInt32 data)
RwInt32	RwCameraAddUserDataArray (RwCamera *camera, RwChar *name, RpUserDataFormat format, RwInt32 numElements)
RwCamera *	RwCameraRemoveUserDataArray (RwCamera *camera, RwInt32 index)
RwInt32	RwCameraGetUserDataArrayCount (const RwCamera *camera)
RpUserDataArray *	RwCameraGetUserDataArray (const RwCamera *camera, RwInt32 data)
RwInt32	RpLightAddUserDataArray (RpLight *light, RwChar *name, RpUserDataFormat format, RwInt32 numElements)
RpLight *	RpLightRemoveUserDataArray (RpLight *light, RwInt32 index)
RwInt32	RpLightGetUserDataArrayCount (const RpLight *light)
RpUserDataArray *	RpLightGetUserDataArray (const RpLight *light, RwInt32 data)
RwInt32	RpMaterialAddUserDataArray (RpMaterial *material, RwChar *name, RpUserDataFormat format, RwInt32 numElements)
RpMaterial *	RpMaterialRemoveUserDataArray (RpMaterial *material, RwInt32 index)
RwInt32	RpMaterialGetUserDataArrayCount (const RpMaterial *material)
RpUserDataArray *	RpMaterialGetUserDataArray (const RpMaterial *material, RwInt32 data)
RwInt32	RwTextureAddUserDataArray (RwTexture *texture, RwChar *name, RpUserDataFormat format, RwInt32 numElements)
RwTexture *	RwTextureRemoveUserDataArray (RwTexture *texture, RwInt32 index)
RwInt32	RwTextureGetUserDataArrayCount (const RwTexture *texture)
RpUserDataArray *	RwTextureGetUserDataArray (const RwTexture *texture, RwInt32 data)
RwChar *	RpUserDataArrayGetName (RpUserDataArray *userData)
RpUserDataFormat	RpUserDataArrayGetFormat (RpUserDataArray *userData)
RwInt32	RpUserDataArrayGetNumElements (RpUserDataArray *userData)
RwInt32	RpUserDataArrayGetInt (RpUserDataArray *userData, RwInt32 index)
RwReal	RpUserDataArrayGetReal (RpUserDataArray *userData, RwInt32 index)
RwChar *	RpUserDataArrayGetString (RpUserDataArray *userData, RwInt32 index)
void	RpUserDataArraySetInt (RpUserDataArray *userData, RwInt32 index, RwInt32 value)
void	RpUserDataArraySetReal (RpUserDataArray *userData, RwInt32 index, RwReal value)
void	RpUserDataArraySetString (RpUserDataArray *userData, RwInt32 index, RwChar *value)
RwInt32	RpUserDataGetFormatSize (RpUserDataFormat format)
RwBool	RpUserDataPluginAttach (void)

---

Detailed Description

User Data Plugin for RenderWare Graphics.

RpUserData Plugin Overview

Requirements

• Headers: rwcore.h, rpworld.h, rpusrdat.h
• Libraries: rwcore, rpworld, rpusrdat
• Plugin attachments: RpWorldPluginAttach, RpUserDataPluginAttach

Overview

The RpUserData plugin provides functionality for storing user defined data with geometry. The plugin extends RpGeometry and RpWorldSector objects. Notionally, the plugin allows array of RpUserDataArray structures to be attached to these objects. Each RpUserDataArray structure has an identifier string, a data type (int, float, string), a number of elements and a pointer to the data.

Requires: Core Library and RpWorld Plugin.

---

Enumeration Type Documentation

enum RpUserDataFormat

User data formats Enumeration values: rpINTUSERDATA  32 bit int data rpREALUSERDATA  32 bit float data rpSTRINGUSERDATA  unsigned byte pointer data

---

Function Documentation

RwInt32 RpGeometryAddUserDataArray (  RpGeometry *    geometry, RwChar *    name, RpUserDataFormat    format, RwInt32    numElements )

RpGeometryAddUserDataArray is used to allocate and add a new RpUserDataArray to a RpGeometry object. The UserData plugin must be attached before using this function. Parameters: geometry  pointer to the geometry object name  an identifier string for the the user data format  the format of the user data array elements numElements  the number of elements on the user data array Returns: an index to the user data array on success, -1 on failure. See also: RpGeometryGetUserDataArray , RpGeometryRemoveUserDataArray , RpUserDataPluginAttach

RpUserDataArray* RpGeometryGetUserDataArray (  const RpGeometry *    geometry, RwInt32    data )

RpGeometryGetUserDataArray is used to retrieve a RpUserDataArray object stored on a RpGeometry. The UserData plugin must be attached before using this function. Parameters: geometry  pointer to the geometry object data  the index of the user data array object to retrieve Returns: a pointer to the user data array object if it exists, NULL otherwise See also: RpGeometryGetUserDataArrayCount , RpUserDataPluginAttach

RwInt32 RpGeometryGetUserDataArrayCount (  const RpGeometry *    geometry )

RpGeometryGetUserDataArrayCount is used to retrieve the number of RpUserDataArray stored with a RpGeometry. The UserData plugin must be attached before using this function. Parameters: geometry  pointer to the geometry object Returns: the number of user data array stored with the geometry on success, otherwise -1 See also: RpGeometryGetUserDataArray , RpUserDataPluginAttach

RpGeometry* RpGeometryRemoveUserDataArray (  RpGeometry *    geometry, RwInt32    index )

RpGeometryRemoveUserDataArray is used to remove and deallocate a RpUserDataArray added to a RpGeometry object by RpGeometryAddUserDataArray. The UserData plugin must be attached before using this function. Parameters: geometry  pointer to the geometry object index  the index of the array to remove Returns: a pointer to the geometry on success, otherwise NULL See also: RpGeometryGetUserDataArray , RpGeometryAddUserDataArray , RpUserDataPluginAttach

RwInt32 RpLightAddUserDataArray (  RpLight *    light, RwChar *    name, RpUserDataFormat    format, RwInt32    numElements )

RpLightAddUserDataArray is used to allocate and add a new RpUserDataArray to a RpLight object. The UserData plugin must be attached before using this function. Parameters: light  pointer to the light object name  an identifier string for the the user data array format  the format of the user data array elements numElements  the number of elements on the user data array Returns: an index to the user data array on success, -1 on failure. See also: RpLightGetUserDataArray , RpLightRemoveUserDataArray , RpUserDataPluginAttach

RpUserDataArray* RpLightGetUserDataArray (  const RpLight *    light, RwInt32    data )

RpLightGetUserDataArray is used to retrieve a RpUserDataArray object stored on a RpLight. The UserData plugin must be attached before using this function. Parameters: light  pointer to the light object data  the index of the user data array object to retrieve Returns: a pointer to the user data array object if it exists, NULL otherwise See also: RpLightGetUserDataArrayCount , RpUserDataPluginAttach

RwInt32 RpLightGetUserDataArrayCount (  const RpLight *    light )

RpLightGetUserDataArrayCount is used to retrieve the number of user data arrays stored with a RpLight. The UserData plugin must be attached before using this function. Parameters: light  pointer to the light object Returns: the number of user data array stored with the light on success, otherwise -1 See also: RpLightGetUserDataArray , RpUserDataPluginAttach

RpLight* RpLightRemoveUserDataArray (  RpLight *    light, RwInt32    index )

RpLightRemoveUserDataArray is used to remove and deallocate a RpUserDataArray added to a RpLight object by RpLightAddUserDataArray. The UserData plugin must be attached before using this function. Parameters: light  pointer to the light object index  the index of the array to remove Returns: a pointer to the camera on success, otherwise NULL See also: RpLightGetUserDataArray , RpLightAddUserDataArray , RpUserDataPluginAttach

RwInt32 RpMaterialAddUserDataArray (  RpMaterial *    material, RwChar *    name, RpUserDataFormat    format, RwInt32    numElements )

RpMaterialAddUserDataArray is used to allocate and add a new RpUserDataArray to a RpMaterial object. The UserData plugin must be attached before using this function. Parameters: material  pointer to the material object name  an identifier string for the the user data array format  the format of the user data array elements numElements  the number of elements on the user data array Returns: an index to the user data array on success, -1 on failure. See also: RpMaterialGetUserDataArray , RpMaterialRemoveUserDataArray , RpUserDataPluginAttach

RpUserDataArray* RpMaterialGetUserDataArray (  const RpMaterial *    material, RwInt32    data )

RpMaterialGetUserDataArray is used to retrieve a RpUserDataArray object stored on a RpMaterial. The UserData plugin must be attached before using this function. Parameters: material  pointer to the material object data  the index of the user data array object to retrieve Returns: a pointer to the user data array object if it exists, NULL otherwise See also: RpMaterialGetUserDataArrayCount , RpUserDataPluginAttach

RwInt32 RpMaterialGetUserDataArrayCount (  const RpMaterial *    material )

RpMaterialGetUserDataArrayCount is used to retrieve the number of user data arrays stored with a RpMaterial. The UserData plugin must be attached before using this function. Parameters: material  pointer to the material object Returns: the number of user data array stored with the material on success, otherwise -1 See also: RpMaterialGetUserDataArray , RpUserDataPluginAttach

RpMaterial* RpMaterialRemoveUserDataArray (  RpMaterial *    material, RwInt32    index )

RpMaterialRemoveUserDataArray is used to remove and deallocate a RpUserDataArray added to a RpMaterial object by RpMaterialAddUserDataArray. The UserData plugin must be attached before using this function. Parameters: material  pointer to the material object index  the index of the array to remove Returns: a pointer to the material on success, otherwise NULL See also: RpMaterialGetUserDataArray , RpMaterialAddUserDataArray , RpUserDataPluginAttach

RpUserDataFormat RpUserDataArrayGetFormat (  RpUserDataArray *    userData )

RpUserDataArrayGetFormat is used to get format of the data elements stored by a RpUserDataArray object. The UserData plugin must be attached before using this function. Parameters: userData  pointer to the user data array object Returns: the format of the elements stored by the user data array object. See also: RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray , RpUserDataPluginAttach

RwInt32 RpUserDataArrayGetInt (  RpUserDataArray *    userData, RwInt32    index )

RpUserDataArrayGetInt is used to get the integer stored at entry index in the RpUserDataArray object. The UserData plugin must be attached before using this function. Parameters: userData  poinnter to the user data array object index  the index in the data array to be retrieved Returns: the integer element See also: RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray , RpUserDataArraySetInt , RpUserDataPluginAttach

RwChar* RpUserDataArrayGetName (  RpUserDataArray *    userData )

RpUserDataArrayGetName is used to retrieve the identifier string attached to a a RpUserDataArray object. The UserData plugin must be attached before using this function. Parameters: userData  pointer to the user data array object Returns: the identifier string of the user data array object. See also: RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray , RpUserDataPluginAttach

RwInt32 RpUserDataArrayGetNumElements (  RpUserDataArray *    userData )

RpUserDataArrayGetNumElements is used to get the number of data elements stored by a RpUserDataArray object. The UserData plugin must be attached before using this function. Parameters: userData  pointer to the user data array object Returns: the number of elements stored by the user data array object. See also: RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray , RpUserDataPluginAttach

RwReal RpUserDataArrayGetReal (  RpUserDataArray *    userData, RwInt32    index )

RpUserDataArrayGetReal is used to get the real stored at entry index in the RpUserDataArray object. The UserData plugin must be attached before using this function. Parameters: userData  pointer to the user data array object index  the index in the data array to be retrieved Returns: the real element See also: RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray , RpUserDataArraySetReal , RpUserDataPluginAttach

RwChar* RpUserDataArrayGetString (  RpUserDataArray *    userData, RwInt32    index )

RpUserDataArrayGetString is used to get the string stored at entry index in the RpUserDataArray object. The UserData plugin must be attached before using this function. Parameters: userData  pointer to the user data array object index  the index in the data array to be retrieved Returns: the string element See also: RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray , RpUserDataArraySetString , RpUserDataPluginAttach

void RpUserDataArraySetInt (  RpUserDataArray *    userData, RwInt32    index, RwInt32    value )

RpUserDataArraySetInt is used to set the integer stored at entry index in the RpUserDataArray object. The UserData plugin must be attached before using this function. Parameters: userData  pointer to the user data array object index  the index in the data array to be stored value  the integer value to be stored See also: RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray , RpUserDataArrayGetInt , RpUserDataPluginAttach

void RpUserDataArraySetReal (  RpUserDataArray *    userData, RwInt32    index, RwReal    value )

RpUserDataArraySetReal is used to set the real stored at entry index in the RpUserDataArray object. The UserData plugin must be attached before using this function. Parameters: userData  pointer to the user data array object index  the index in the data array to be stored value  the real value to be stored See also: RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray , RpUserDataArrayGetReal , RpUserDataPluginAttach

void RpUserDataArraySetString (  RpUserDataArray *    userData, RwInt32    index, RwChar *    value )

RpUserDataArraySetString is used to set the string stored at entry index in the RpUserDataArray object. The UserData plugin must be attached before using this function. Parameters: userData  pointer to the user data array object index  the index in the data array to be stored value  the string value to be stored See also: RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray , RpUserDataArrayGetReal , RpUserDataPluginAttach

RwInt32 RpUserDataGetFormatSize (  RpUserDataFormat    format )

RpUserDataGetFormatSize is used get the size (in bytes) of a given UserData element format. The UserData plugin must be attached before using this function. Parameters: format  the user data array format Returns: size of the user data array format in bytes. See also: RpUserDataPluginAttach

RwBool RpUserDataPluginAttach (  void    )

RpUserDataPluginAttach is used to attach the UserData plugin to the RenderWare system. The plugin must be attached between initializing the system with RwEngineInit and opening it with RwEngineOpen. Note that the include file rpusrdat.h is required and must be included by an application wishing to use this facility. The UserData library is contained in the file rpusrdat.lib. Returns: Returns TRUE if successful, FALSE otherwise an error. See also: RpGeometryAddUserDataArray , RpWorldSectorAddUserDataArray , RwFrameAddUserDataArray , RpGeometryRemoveUserDataArray , RpWorldSectorRemoveUserDataArray , RwFrameRemoveUserDataArray , RpGeometryGetUserDataArray , RpWorldSectorGetUserDataArray , RwFrameGetUserDataArray

RwInt32 RpWorldSectorAddUserDataArray (  RpWorldSector *    sector, RwChar *    name, RpUserDataFormat    format, RwInt32    numElements )

RpWorldSectorAddUserDataArray is used to allocate and add a new RpUserDataArray to a RpWorldSector object. The UserData plugin must be attached before using this function. Parameters: sector  pointer to the world sector object name  an identifier string for the the user data array format  the format of the user data array elements numElements  the number of elements on the user data array Returns: an index to the user data array on success, -1 on failure. See also: RpWorldSectorGetUserDataArray , RpWorldSectorRemoveUserDataArray , RpUserDataPluginAttach

RpUserDataArray* RpWorldSectorGetUserDataArray (  const RpWorldSector *    sector, RwInt32    data )

RpWorldSectorGetUserDataArray is used to retrieve a RpUserDataArray object stored on a RpWorldSector. The UserData plugin must be attached before using this function. Parameters: sector  pointer to the world sector object data  the index of the user data array object to retrieve Returns: a pointer to the user data array object if it exists, NULL otherwise See also: RpWorldSectorGetUserDataArrayCount , RpUserDataPluginAttach

RwInt32 RpWorldSectorGetUserDataArrayCount (  const RpWorldSector *    sector )

RpWorldSectorGetUserDataArrayCount is used to retrieve the number of RpUserDataArray stored with a RpWorldSector. The UserData plugin must be attached before using this function. Parameters: sector  pointer to the world sector object Returns: the number of user data arrays stored with the world sector on success, otherwise -1 See also: RpWorldSectorGetUserDataArray , RpUserDataPluginAttach

RpWorldSector* RpWorldSectorRemoveUserDataArray (  RpWorldSector *    sector, RwInt32    index )

RpWorldSectorRemoveUserDataArray is used to remove and deallocate a RpUserDataArray added to a RpWorldSector object by RpWorldSectorAddUserDataArray. The UserData plugin must be attached before using this function. Parameters: sector  pointer to the world sector object index  the index of the array to remove Returns: a pointer to the world sector on success, otherwise NULL See also: RpWorldSectorGetUserDataArray , RpWorldSectorAddUserDataArray , RpUserDataPluginAttach

RwInt32 RwCameraAddUserDataArray (  RwCamera *    camera, RwChar *    name, RpUserDataFormat    format, RwInt32    numElements )

RwCameraAddUserDataArray is used to allocate and add a new RpUserDataArray to a RwCamera object. The UserData plugin must be attached before using this function. Parameters: camera  pointer to the camera object name  an identifier string for the the user data array format  the format of the user data array elements numElements  the number of elements on the user data array Returns: an index to the user data array on success, -1 on failure. See also: RwCameraGetUserDataArray , RwCameraRemoveUserDataArray , RpUserDataPluginAttach

RpUserDataArray* RwCameraGetUserDataArray (  const RwCamera *    camera, RwInt32    data )

RwCameraGetUserDataArray is used to retrieve a RpUserDataArray object stored on a RwCamera. The UserData plugin must be attached before using this function. Parameters: camera  pointer to the camera object data  the index of the user data array object to retrieve Returns: a pointer to the user data array object if it exists, NULL otherwise See also: RwCameraGetUserDataArrayCount , RpUserDataPluginAttach

RwInt32 RwCameraGetUserDataArrayCount (  const RwCamera *    camera )

RwCameraGetUserDataArrayCount is used to retrieve the number of user data arrays stored with a RwCamera. The UserData plugin must be attached before using this function. Parameters: camera  pointer to the camera object Returns: the number of user data array stored with the camera on success, otherwise -1 See also: RwCameraGetUserDataArray , RpUserDataPluginAttach

RwCamera* RwCameraRemoveUserDataArray (  RwCamera *    camera, RwInt32    index )

RwCameraRemoveUserDataArray is used to remove and deallocate a RpUserDataArray added to a RwCamera object by RwCameraAddUserDataArray. The UserData plugin must be attached before using this function. Parameters: camera  pointer to the camera object index  the index of the array to remove Returns: a pointer to the camera on success, otherwise NULL See also: RwCameraGetUserDataArray , RwCameraAddUserDataArray , RpUserDataPluginAttach

RwInt32 RwFrameAddUserDataArray (  RwFrame *    frame, RwChar *    name, RpUserDataFormat    format, RwInt32    numElements )

RwFrameAddUserDataArray is used to allocate and add a new RpUserDataArray to a RwFrame object. The UserData plugin must be attached before using this function. Parameters: frame  pointer to the frame object name  an identifier string for the the user data array format  the format of the user data array elements numElements  the number of elements on the user data array Returns: an index to the user data array on success, -1 on failure. See also: RwFrameGetUserDataArray , RwFrameRemoveUserDataArray , RpUserDataPluginAttach

RpUserDataArray* RwFrameGetUserDataArray (  const RwFrame *    frame, RwInt32    data )

RwFrameGetUserDataArray is used to retrieve a RpUserDataArray object stored on a RwFrame. The UserData plugin must be attached before using this function. Parameters: frame  pointer to the frame object data  the index of the user data array object to retrieve Returns: a pointer to the user data array object if it exists, NULL otherwise See also: RwFrameGetUserDataArrayCount , RpUserDataPluginAttach

RwInt32 RwFrameGetUserDataArrayCount (  const RwFrame *    frame )

RwFrameGetUserDataArrayCount is used to retrieve the number of user data arrays stored with a RwFrame. The UserData plugin must be attached before using this function. Parameters: frame  pointer to the frame object Returns: the number of user data array stored with the frame on success, otherwise -1 See also: RwFrameGetUserDataArray , RpUserDataPluginAttach

RwFrame* RwFrameRemoveUserDataArray (  RwFrame *    frame, RwInt32    index )

RwFrameRemoveUserDataArray is used to remove and deallocate a RpUserDataArray added to a RwFrame object by RwFrameAddUserDataArray. The UserData plugin must be attached before using this function. Parameters: frame  pointer to the frame object index  the index of the array to remove Returns: a pointer to the frame on success, otherwise NULL See also: RwFrameGetUserDataArray , RwFrameAddUserDataArray , RpUserDataPluginAttach

RwInt32 RwTextureAddUserDataArray (  RwTexture *    texture, RwChar *    name, RpUserDataFormat    format, RwInt32    numElements )

RwTextureAddUserDataArray is used to allocate and add a new RpUserDataArray to a RwTexture object. The UserData plugin must be attached before using this function. Parameters: texture  pointer to the texture object name  an identifier string for the the user data array format  the format of the user data array elements numElements  the number of elements on the user data array Returns: an index to the user data array on success, -1 on failure. See also: RwTextureGetUserDataArray , RwTextureRemoveUserDataArray , RpUserDataPluginAttach

RpUserDataArray* RwTextureGetUserDataArray (  const RwTexture *    texture, RwInt32    data )

RwTextureGetUserDataArray is used to retrieve a RpUserDataArray object stored on a RwTexture. The UserData plugin must be attached before using this function. Parameters: texture  pointer to the texture object data  the index of the user data array object to retrieve Returns: a pointer to the user data array object if it exists, NULL otherwise See also: RwTextureGetUserDataArrayCount , RpUserDataPluginAttach

RwInt32 RwTextureGetUserDataArrayCount (  const RwTexture *    texture )

RwTextureGetUserDataArrayCount is used to retrieve the number of user data arrays stored with a RwTexture. The UserData plugin must be attached before using this function. Parameters: texture  pointer to the texture object Returns: the number of user data array stored with the texture on success, otherwise -1 See also: RwTextureGetUserDataArray , RpUserDataPluginAttach

RwTexture* RwTextureRemoveUserDataArray (  RwTexture *    texture, RwInt32    index )

RwTextureRemoveUserDataArray is used to remove and deallocate a RpUserDataArray added to a RwTexture object by RwTextureAddUserDataArray. The UserData plugin must be attached before using this function. Parameters: texture  pointer to the texture object index  the index of the array to remove Returns: a pointer to the texture on success, otherwise NULL See also: RwTextureGetUserDataArray , RwTextureAddUserDataArray , RpUserDataPluginAttach

---