Main Page Modules Class Hierarchy Alphabetical List Compound List Compound Members
CSLBaseShape Class Reference
#include <BaseShape.h>
Inheritance diagram for CSLBaseShape::
List of all members.Public Types
- typedef CSLArrayProxy< CSIBCVector2D,
SI_Float, 2 > CSLVector2DArray
- typedef CSLArrayProxy< CSIBCVector3D,
SI_Float, 3 > CSLVector3DArray
- typedef CSLArrayProxy< CSIBCColorf,
SI_Float, 4 > CSLColorArray
- typedef CSLArrayProxy< SLIndexedVector2D,
SI_Float, 3 > CSLIndexedVector2DArray
- typedef CSLArrayProxy< SLIndexedVector3D,
SI_Float, 4 > CSLIndexedVector3DArray
- typedef CSLArrayProxy< SLIndexedColor,
SI_Float, 5 > CSLIndexedColorArray
- enum EShapeType { SI_ORDERED,
SI_INDEXED
}
Public Methods
Protected Methods
Detailed Description
Describes the shape of a mesh
The CSLBaseShape class contains information about the position coordinates, normal coordinates and color values of a mesh.
There are two possible types of shape: ordered & indexed. The set of functions that can be used depends on the type of shape that is described by each class instance.
For example, the function CreateNormals will work on an ordered shape, but won't on an indexed shape. On the other hand, the function CreateIndexedNormals will work on an indexed shape, but won't on an ordered shape. However, the functions DestroyNormals and GetNormalCount will work with both types (ordered & indexed).
Example - Using CSLBaseShape
Member Typedef Documentation
|
Proxy class that allows modifying a list of CSIBCColorf objects like an array. |
|
Proxy class that allows modifying a list of SLIndexedColor objects like an array. |
|
Proxy class that allows modifying a list of CSIBCVector2D objects like an array. |
|
Proxy class that allows modifying a list of CSIBCVector3D objects like an array. |
Member Enumeration Documentation
enum CSLBaseShape::EShapeType
|
|
|
The EShapeType enum contains possible types for a shape -
Enumeration values:
-
SI_ORDERED |
The shape is of ordered type |
SI_INDEXED |
The shape is of indexed type |
|
Constructor & Destructor Documentation
CSLBaseShape::~CSLBaseShape |
( |
|
) |
[virtual] |
|
|
Constructor -
Parameters:
-
in_pScene |
Pointer to the scene containing the BaseShape |
in_pModel |
Pointer to the model containing the BaseShape |
in_pTemplate |
Pointer to the CdotXSITemplate containing the BaseShape |
in_Type |
The shape type to be used in the BaseShape |
|
Member Function Documentation
|
Create a color values array. -
Returns:
-
CSLColorArray* Pointer to the newly created array.
|
|
Create an indexed color values array. -
Returns:
-
CSLIndexedColorArray* Pointer to the newly created indexed array.
|
|
Create an indexed normal coordinates array. -
Returns:
-
CSLIndexedVector3DArray* Pointer to the newly created indexed array.
|
|
Create a normal coordinates array. -
Returns:
-
CSLVector3DArray* Pointer to the newly created array.
|
SI_Error CSLBaseShape::DestroyColors |
( |
|
) |
|
|
|
Destroy the color values array. -
Returns:
-
SI_Error Error code.
|
SI_Error CSLBaseShape::DestroyNormals |
( |
|
) |
|
|
|
Destroy the normal coordinates array. -
Returns:
-
SI_Error Error code.
|
SI_Error CSLBaseShape::Fix |
( |
|
) |
[virtual] |
|
|
Clean invalid data from the template. -
Returns:
-
SI_Error Error code
Reimplemented from CSLTemplate. |
SI_Int CSLBaseShape::GetColorCount |
( |
|
) |
|
|
|
Return the number of color values. -
Returns:
-
SI_Int Number of colors.
|
|
Return the color values array proxy. -
Returns:
-
CSLColorArray* Pointer to an array proxy of colors.
|
|
Return the indexed color values array proxy. -
Returns:
-
CSLIndexedVector3DArray* Pointer to an array proxy of indexed colors.
|
|
Return the indexed normal coordinate array proxy. -
Returns:
-
CSLIndexedVector3DArray* Pointer to an array proxy of indexed normals.
|
|
Return the indexed vertex coordinate array proxy. -
Returns:
-
CSLIndexedVector3DArray* Pointer to an array proxy of indexed vertices.
|
SI_Int CSLBaseShape::GetNormalCount |
( |
|
) |
|
|
|
Return the number of normal coordinates. -
Returns:
-
SI_Int Number of normals.
|
|
Return the normal coordinate array proxy. -
Returns:
-
CSLVector3DArray* Pointer to an array proxy of normals.
|
SI_Int CSLBaseShape::GetVertexCount |
( |
|
) |
|
|
|
Return the number of vertex coordinates. -
Returns:
-
SI_Int Number of vertices.
|
|
Return the vertex coordinate array proxy. -
Returns:
-
CSLVector3DArray* Pointer to an array proxy of vertices.
|
|
Indicate which type of shape this object describes. -
Returns:
-
EShapeType Type of shape
|
SI_Error CSLBaseShape::Synchronize |
( |
|
) |
[virtual] |
|
|
Synchronize will ensure that the animated parameter is up to date. -
Returns:
-
SI_Error Error code
Reimplemented from CSLTemplate.
Reimplemented in CSLShape, and CSLShape_35. |
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.