NSMeshes::TDeclaration Class Reference

This class defines declaration loaded from declaration file. More...

#include <Declaration.h>

Inheritance diagram for NSMeshes::TDeclaration:

Inheritance graph
[legend]
Collaboration diagram for NSMeshes::TDeclaration:

Collaboration graph
[legend]
List of all members.

Public Member Functions

const TStringGetName (void) const
 Returns declaration name - name of file from that declaration was loaded.
TRendererVertexDeclarationGetDeclaration (void) const
 Return device declaration stored inside this object.
DWORD GetVertexType (void) const
 Returns vertex type of vertices created under this declaration.
DWORD GetVertexSize (void) const
 Returns size of vertex created by this declaration.
void Release (void)
 Release this declaration.

Friends

class TArrayPtrs< TDeclaration >
class TDeclarationManager

Detailed Description

This class defines declaration loaded from declaration file.

TDeclaration is always created and destroyed in TDeclarationManager.

Definition at line 86 of file Declaration.h.


Member Function Documentation

TRendererVertexDeclaration * NSMeshes::TDeclaration::GetDeclaration void   )  const [inline]
 

Return device declaration stored inside this object.

Warning:
This method DO NOT increase number of references to device declaration. You should use this method only when you can set declaration to device - e.g. TRenderer::SetVertexDeclaration(decl->GetDeclaration()). If you want use declaration for long term then you must call AddRefs and manage declaration resource properly.

Definition at line 154 of file Declaration.h.

const TString & NSMeshes::TDeclaration::GetName void   )  const [inline]
 

Returns declaration name - name of file from that declaration was loaded.

Definition at line 128 of file Declaration.h.

DWORD NSMeshes::TDeclaration::GetVertexSize void   )  const [inline]
 

Returns size of vertex created by this declaration.

Definition at line 177 of file Declaration.h.

DWORD NSMeshes::TDeclaration::GetVertexType void   )  const [inline]
 

Returns vertex type of vertices created under this declaration.

Definition at line 170 of file Declaration.h.

void NSMeshes::TDeclaration::Release void   )  [inline]
 

Release this declaration.

Decrease number of references.

Warning:
After calling this method pointer should be invalid.

Because declaration is small resource declaration with references equal to 0 still exists in declaration manager. Nevertheless you should set pointer after Release to NULL to archievement clear code!!!

Definition at line 141 of file Declaration.h.


Friends And Related Function Documentation

friend class TArrayPtrs< TDeclaration > [friend]
 

Definition at line 88 of file Declaration.h.

friend class TDeclarationManager [friend]
 

Definition at line 89 of file Declaration.h.


The documentation for this class was generated from the following files:
Generated on Wed Nov 28 23:08:22 2007 for Joy4D by  doxygen 1.4.6-NO