CrystalSpace

Public API Reference

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

iPolygonHandle Struct Reference

This is an interface that can be used to represent a polygon in situations where a SCF object is required. More...

#include <thing.h>

Inheritance diagram for iPolygonHandle:

iBase List of all members.

Public Methods

virtual iThingFactoryStateGetThingFactoryState () const=0
 Get the factory state for this polygon.

virtual iMeshObjectFactoryGetMeshObjectFactory () const=0
 Get the mesh object factory for this polygon.

virtual iThingStateGetThingState () const=0
 Get the instance of this polygon.

virtual iMeshObjectGetMeshObject () const=0
 Get the mesh object of this polygon.

virtual int GetIndex () const=0
 Get the polygon index which this polygon handle represents.


Detailed Description

This is an interface that can be used to represent a polygon in situations where a SCF object is required.

Create an instance of this object using iThingFactoryState->CreatePolygonHandle() or iThingState->CreatePolygonHandle(). Note that this handle will make sure that the returned pointers are cleared if the thing or thing factory happens to be removed.

Definition at line 136 of file thing.h.


Member Function Documentation

virtual int iPolygonHandle::GetIndex   [pure virtual]
 

Get the polygon index which this polygon handle represents.

virtual iMeshObject* iPolygonHandle::GetMeshObject   [pure virtual]
 

Get the mesh object of this polygon.

This can be 0 if this polygon handle was created from a factory or if the instance was removed.

virtual iMeshObjectFactory* iPolygonHandle::GetMeshObjectFactory   [pure virtual]
 

Get the mesh object factory for this polygon.

Or 0 if the factory is removed.

virtual iThingFactoryState* iPolygonHandle::GetThingFactoryState   [pure virtual]
 

Get the factory state for this polygon.

Or 0 if the factory is removed.

virtual iThingState* iPolygonHandle::GetThingState   [pure virtual]
 

Get the instance of this polygon.

This can be 0 if this polygon handle was created from a factory or if the instance was removed.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18