CrystalSpace

Public API Reference

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

iMeshObjectFactory Struct Reference

This object is a factory which can generate mesh objects of a certain type. More...

#include <imesh/object.h>

Inheritance diagram for iMeshObjectFactory:

iBase csMeshFactory List of all members.

Public Member Functions

virtual csFlagsGetFlags ()=0
 Get flags for this factory.
virtual csPtr< iMeshObjectNewInstance ()=0
 Create an instance of iMeshObject.
virtual csPtr< iMeshObjectFactoryClone ()=0
 Creates a copy of this factory and returns the clone.
virtual void HardTransform (const csReversibleTransform &t)=0
 Do a hard transform of this factory.
virtual bool SupportsHardTransform () const =0
 Return true if HardTransform is supported for this factory.
virtual void SetLogicalParent (iBase *logparent)=0
 Set a reference to some logical parent in the context that holds the mesh factories.
virtual iBaseGetLogicalParent () const =0
 Get the logical parent for this mesh factory.
virtual iMeshObjectTypeGetMeshObjectType () const =0
 Get the ObjectType for this mesh factory.
virtual iObjectModelGetObjectModel ()=0
 Get the generic interface describing the geometry of this mesh factory.

Detailed Description

This object is a factory which can generate mesh objects of a certain type.

For example, if you want to have multiple sets of sprites from the same sprite template then you should have an instance of iMeshObjectFactory for evey sprite template and an instance of iMeshObject for every sprite.

To use a mesh factory in the engine, you have to create a mesh factory wrapper for it.

Main creators of instances implementing this interface:

Main ways to get pointers to this interface: Main users of this interface:

Definition at line 284 of file object.h.


Member Function Documentation

virtual csPtr<iMeshObjectFactory> iMeshObjectFactory::Clone  )  [pure virtual]
 

Creates a copy of this factory and returns the clone.

virtual csFlags& iMeshObjectFactory::GetFlags  )  [pure virtual]
 

Get flags for this factory.

The following flags are at least supported:

  • #CS_FACTORY_STATICSHAPE: factory will never animate.
Mesh factories may implement additional flags. These mesh factory specific flags must be equal to at least 0x00010000.

Implemented in csMeshFactory.

virtual iBase* iMeshObjectFactory::GetLogicalParent  )  const [pure virtual]
 

Get the logical parent for this mesh factory.

See SetLogicalParent() for more information.

Implemented in csMeshFactory.

virtual iMeshObjectType* iMeshObjectFactory::GetMeshObjectType  )  const [pure virtual]
 

Get the ObjectType for this mesh factory.

Implemented in csMeshFactory.

virtual iObjectModel* iMeshObjectFactory::GetObjectModel  )  [pure virtual]
 

Get the generic interface describing the geometry of this mesh factory.

It is possible that this will return 0 if the factory itself doesn't support the geometry. In that case you need to get the object model from the individual instance instead. Note that for collision detection and other parts of CS it is prefered to use the factory object model when available as that reduces the amount of redundant memory usage.

Implemented in csMeshFactory.

virtual void iMeshObjectFactory::HardTransform const csReversibleTransform t  )  [pure virtual]
 

Do a hard transform of this factory.

This transformation and the original coordinates are not remembered but the object space coordinates are directly computed (world space coordinates are set to the object space coordinates by this routine). Note that some implementations of mesh objects will not change the orientation of the object but only the position.

Implemented in csMeshFactory.

virtual csPtr<iMeshObject> iMeshObjectFactory::NewInstance  )  [pure virtual]
 

Create an instance of iMeshObject.

Implemented in csMeshFactory.

virtual void iMeshObjectFactory::SetLogicalParent iBase logparent  )  [pure virtual]
 

Set a reference to some logical parent in the context that holds the mesh factories.

When a mesh factory is used in the context of the 3D engine then this will be an iMeshFactoryWrapper. Similarly for the isometric engine. Note that this function should NOT increase the ref-count of the given logical parent because this would cause a circular reference (since the logical parent already holds a reference to this mesh factory).

Implemented in csMeshFactory.

virtual bool iMeshObjectFactory::SupportsHardTransform  )  const [pure virtual]
 

Return true if HardTransform is supported for this factory.

Implemented in csMeshFactory.


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