- Cal3D 0.9 API Reference -

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   Related Pages  

CalPhysique Class Reference

The physique class. More...

#include <physique.h>

List of all members.

Public Methods

 CalPhysique ()
 Constructs the physique instance. More...

virtual ~CalPhysique ()
 Destructs the physique instance. More...

int calculateTangentSpaces (CalSubmesh *pSubmesh, int mapId, float *pTangentSpaceBuffer)
 Calculates the transformed tangent space data. More...

int calculateNormals (CalSubmesh *pSubmesh, float *pNormalBuffer)
 Calculates the transformed normal data. More...

int calculateVertices (CalSubmesh *pSubmesh, float *pVertexBuffer)
 Calculates the transformed vertex data. More...

int calculateVerticesAndNormals (CalSubmesh *pSubmesh, float *pVertexBuffer)
 Calculates the transformed vertex data. More...

int calculateVerticesNormalsAndTexCoords (CalSubmesh *pSubmesh, float *pVertexBuffer, int NumTexCoords=1)
 Calculates the transformed vertex data. More...

bool create (CalModel *pModel)
 Creates the physique instance. More...

void destroy ()
 Destroys the physique instance. More...

void update ()
 Updates all the internally handled attached meshes. More...

void setNormalization (bool normalize)
 Sets the normalization flag to true or false. More...


Public Attributes

CalModel * m_pModel
bool m_Normalize

Detailed Description

The physique class.

Constructor & Destructor Documentation

CalPhysique::CalPhysique (    ) 
 

Constructs the physique instance.

This function is the default constructor of the physique instance.

CalPhysique::~CalPhysique (    )  [virtual]
 

Destructs the physique instance.

This function is the destructor of the physique instance.

Member Function Documentation

int CalPhysique::calculateNormals (  CalSubmesh *    pSubmesh,
float *    pNormalBuffer
) 
 

Calculates the transformed normal data.

This function calculates and returns the transformed normal data of a specific submesh.

Parameters:
pSubmesh  A pointer to the submesh from which the normal data should be calculated and returned.
pNormalBuffer  A pointer to the user-provided buffer where the normal data is written to.
Returns:
The number of normals written to the buffer.

int CalPhysique::calculateTangentSpaces (  CalSubmesh *    pSubmesh,
int    mapId,
float *    pTangentSpaceBuffer
) 
 

Calculates the transformed tangent space data.

This function calculates and returns the transformed tangent space data of a specific submesh.

Parameters:
pSubmesh  A pointer to the submesh from which the tangent space data should be calculated and returned.
mapId 
pTangentSpaceBuffer  A pointer to the user-provided buffer where the tangent space data is written to.
Returns:
The number of tangent spaces written to the buffer.

int CalPhysique::calculateVertices (  CalSubmesh *    pSubmesh,
float *    pVertexBuffer
) 
 

Calculates the transformed vertex data.

This function calculates and returns the transformed vertex data of a specific submesh.

Parameters:
pSubmesh  A pointer to the submesh from which the vertex data should be calculated and returned.
pVertexBuffer  A pointer to the user-provided buffer where the vertex data is written to.
Returns:
The number of vertices written to the buffer.

int CalPhysique::calculateVerticesAndNormals (  CalSubmesh *    pSubmesh,
float *    pVertexBuffer
) 
 

Calculates the transformed vertex data.

This function calculates and returns the transformed vertex and the transformed normal datadata of a specific submesh.

Parameters:
pSubmesh  A pointer to the submesh from which the vertex data should be calculated and returned.
pVertexBuffer  A pointer to the user-provided buffer where the vertex data is written to.
Returns:
The number of vertices written to the buffer.

int CalPhysique::calculateVerticesNormalsAndTexCoords (  CalSubmesh *    pSubmesh,
float *    pVertexBuffer,
int    NumTexCoords = 1
) 
 

Calculates the transformed vertex data.

This function calculates and returns the transformed vertex, the transformed normal datadata and the texture coords of a specific submesh.

Parameters:
pSubmesh  A pointer to the submesh from which the vertex data should be calculated and returned.
pVertexBuffer  A pointer to the user-provided buffer where the vertex data is written to.
NumTexCoords  A integer with the number of texture coords
Returns:
The number of vertices written to the buffer.

bool CalPhysique::create (  CalModel *    pModel ) 
 

Creates the physique instance.

This function creates the physique instance.

Parameters:
pModel  A pointer to the model that should be managed with this physique instance.
Returns:
One of the following values:
  • true if successful
  • false if an error happend

void CalPhysique::destroy (    ) 
 

Destroys the physique instance.

This function destroys all data stored in the physique instance and frees all allocated memory.

void CalPhysique::setNormalization (  bool    normalize ) 
 

Sets the normalization flag to true or false.

This function sets the normalization flag on or off. If off, the normals calculated by Cal3D will not be normalized. Instead, this transform is left up to the user.

void CalPhysique::update (    ) 
 

Updates all the internally handled attached meshes.

This function updates all the attached meshes of the model that are handled internally.

The documentation for this class was generated from the following files:
Generated at Sun Oct 12 18:38:50 2003 by The Cal3D Team with doxygen 1.2.14 © 1997-2001 Dimitri van Heesch