Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLUserData Class Reference

#include <XSIUserData.h>

Inheritance diagram for CSLUserData::

CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Class CSLUserData

Defines XSI user-defined data

Note:
This template was introduced in dotXSI Version 3.6
See also:
CSLUserDataList


Constructor & Destructor Documentation

CSLUserData::CSLUserData CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Parent scene
in_pModel  Parent model
in_pTemplate  Refered template


Member Function Documentation

SI_Int CSLUserData::GetSubElementCount  
 

Gets the number of sub elements

Returns:
SI_Int Number of sub elements indices

CSLUserData::CSLIntArray * CSLUserData::GetSubElementList  
 

Gets the sub element array

Returns:
CSLIntArray Pointer to the array containing indices for all affected vertices/edges/polygons

SI_Int * CSLUserData::GetSubElementListPtr  
 

Gets a pointer to the sub element array

Returns:
SI_Int Pointer to the array containing indices for all affected vertices/edges/polygons

SI_Int CSLUserData::GetUserDataCount  
 

Gets the size of the user data array

Returns:
SI_Int size of the user data

CSLUserData::CSLUByteArray * CSLUserData::GetUserDataList  
 

Gets the user data array

Returns:
CSLUByteArray Array of user data

SI_UByte * CSLUserData::GetUserDataListPtr  
 

Gets pointer the user data array

Returns:
SI_Int Pointer to the array containing the user data

SI_Error CSLUserData::Synchronize   [virtual]
 

Commits semantic layer data

Returns:
SI_Error Whether or not commit was a success

Reimplemented from CSLTemplate.

ETemplateType CSLUserData::Type   [inline, virtual]
 

Gets the type of this template

Returns:
ETemplateType The type of this template: XSI_USER_DATA

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.