Particle Universe  1.2
ParticleUniverse::PrimitiveShapeSet Class Reference

#include <ParticleUniversePrimitiveShapeSet.h>

Inheritance diagram for ParticleUniverse::PrimitiveShapeSet:

Public Member Functions

 PrimitiveShapeSet (const String &name, unsigned int poolSize=20, bool externalData=false)
 
 PrimitiveShapeSet (void)
 
virtual ~PrimitiveShapeSet (void)
 
virtual void setZRotated (bool zRotated)
 
virtual bool isZRotated (void) const
 
virtual void _notifyZRotated (void)
 
virtual void setMaterialName (const String &name)
 
virtual const StringgetMaterialName (void) const
 
virtual void _notifyResized (void)
 
virtual void _notifyCurrentCamera (Camera *cam)
 
virtual const AxisAlignedBoxgetBoundingBox (void) const
 
virtual Real getBoundingRadius (void) const
 
virtual const Ogre::MaterialPtrgetMaterial (void) const
 
virtual void getWorldTransforms (Ogre::Matrix4 *xform) const
 
virtual const QuaterniongetWorldOrientation (void) const
 
virtual const Vector3getWorldPosition (void) const
 
virtual bool isCullIndividually (void) const
 
virtual void setCullIndividually (bool cullIndividual)
 
virtual Real getSquaredViewDepth (const Camera *cam) const
 
virtual const Ogre::LightListgetLights (void) const
 
virtual uint32 getTypeFlags (void) const
 
virtual void rotateTexture (Real speed)
 
virtual void visitRenderables (Ogre::Renderable::Visitor *visitor, bool debugRenderables=false)
 
- Public Member Functions inherited from Ogre::MovableObject
 MovableObject ()
 
 MovableObject (const String &name)
 
virtual ~MovableObject ()
 
MovableObjectFactory_getCreator (void) const
 
LightList_getLightList ()
 
SceneManager_getManager (void) const
 
virtual const Matrix4_getParentNodeFullTransform (void) const
 
virtual void _notifyAttached (Node *parent, bool isTagPoint=false)
 
virtual void _notifyCreator (MovableObjectFactory *fact)
 
virtual void _notifyManager (SceneManager *man)
 
virtual void _notifyMoved (void)
 
virtual void _releaseManualHardwareResources ()
 
virtual void _restoreManualHardwareResources ()
 
virtual void _updateRenderQueue (RenderQueue *queue)=0
 
void addQueryFlags (uint32 flags)
 
void addVisibilityFlags (uint32 flags)
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 
void detachFromParent (void)
 
const StringVectorgetAnimableValueNames (void) const
 
bool getCastShadows (void) const
 
const AxisAlignedBoxgetDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
 
EdgeDatagetEdgeList (void)
 
const AxisAlignedBoxgetLightCapBounds (void) const
 
uint32 getLightMask () const
 
ListenergetListener (void) const
 
virtual const StringgetMovableType (void) const =0
 
const StringgetName (void) const
 
NodegetParentNode (void) const
 
SceneNodegetParentSceneNode (void) const
 
Real getPointExtrusionDistance (const Light *l) const
 
uint32 getQueryFlags (void) const
 
bool getReceivesShadows ()
 
Real getRenderingDistance (void) const
 
Real getRenderingMinPixelSize () const
 
uint8 getRenderQueueGroup (void) const
 
ShadowRenderableListIterator getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 
const UserObjectBindingsgetUserObjectBindings () const
 
uint32 getVisibilityFlags (void) const
 
bool getVisible (void) const
 
virtual const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 
virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 
bool hasEdgeList (void)
 
bool isAttached (void) const
 
bool isDebugDisplayEnabled (void) const
 
virtual bool isInScene (void) const
 
bool isParentTagPoint () const
 
virtual bool isVisible (void) const
 
const LightListqueryLights (void) const
 
void removeQueryFlags (uint32 flags)
 
void removeVisibilityFlags (uint32 flags)
 
void setCastShadows (bool enabled)
 
void setDebugDisplayEnabled (bool enabled)
 
void setLightMask (uint32 lightMask)
 
void setListener (Listener *listener)
 
void setQueryFlags (uint32 flags)
 
void setRenderingDistance (Real dist)
 
void setRenderingMinPixelSize (Real pixelSize)
 
virtual void setRenderQueueGroup (uint8 queueID)
 
virtual void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 
void setUserAny (const Any &anything)
 
void setVisibilityFlags (uint32 flags)
 
void setVisible (bool visible)
 
- Public Member Functions inherited from Ogre::ShadowCaster
virtual ~ShadowCaster ()
 
- Public Member Functions inherited from Ogre::AnimableObject
 AnimableObject ()
 
virtual ~AnimableObject ()
 
const StringVectorgetAnimableValueNames (void) const
 
- Public Member Functions inherited from Ogre::Renderable
 Renderable ()
 
virtual ~Renderable ()
 
virtual void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 
virtual bool getCastsShadows (void) const
 
const Vector4getCustomParameter (size_t index) const
 
virtual unsigned short getNumWorldTransforms (void) const
 
bool getPolygonModeOverrideable (void) const
 
virtual void getRenderOperation (RenderOperation &op)=0
 
const RenderSystemDataPtrgetRenderSystemData () const
 
virtual TechniquegetTechnique (void) const
 
bool getUseIdentityProjection (void) const
 
bool getUseIdentityView (void) const
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 
const UserObjectBindingsgetUserObjectBindings () const
 
bool hasCustomParameter (size_t index) const
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 
void removeCustomParameter (size_t index)
 
void setCustomParameter (size_t index, const Vector4 &value)
 
void setPolygonModeOverrideable (bool override)
 
void setRenderSystemData (RenderSystemDataPtr val) const
 
void setUseIdentityProjection (bool useIdentityProjection)
 
void setUseIdentityView (bool useIdentityView)
 
void setUserAny (const Any &anything)
 

Protected Attributes

AxisAlignedBox mAABB
 
Real mBoundingRadius
 
String mMaterialName
 
Ogre::MaterialPtr mpMaterial
 
bool mCullIndividual
 
bool mWorldSpace
 
CameramCurrentCamera
 
bool mZRotated
 
bool mAllDefaultSize
 

Additional Inherited Members

- Public Types inherited from Ogre::MovableObject
typedef vector< ShadowRenderable * >::type ShadowRenderableList
 
typedef VectorIterator< ShadowRenderableListShadowRenderableListIterator
 
- Public Types inherited from Ogre::ShadowCaster
typedef vector< ShadowRenderable * >::type ShadowRenderableList
 
typedef VectorIterator< ShadowRenderableListShadowRenderableListIterator
 
- Public Types inherited from Ogre::Renderable
typedef SharedPtr< RenderSystemDataRenderSystemDataPtr
 
- Static Public Member Functions inherited from Ogre::MovableObject
static void clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
 
static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
 
static uint32 getDefaultQueryFlags ()
 
static uint32 getDefaultVisibilityFlags ()
 
static void setDefaultQueryFlags (uint32 flags)
 
static void setDefaultVisibilityFlags (uint32 flags)
 
- Static Public Member Functions inherited from Ogre::ShadowCaster
static void clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
 
static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
 

Detailed Description

The PrimitiveShapeSet is comparable with the BillboardSet in Ogre and provides a virtual class in which some basic functions are implemented. This class cannot be used on its own, but must always be subclassed.

Constructor & Destructor Documentation

ParticleUniverse::PrimitiveShapeSet::PrimitiveShapeSet ( const String name,
unsigned int  poolSize = 20,
bool  externalData = false 
)

Default constructor.

ParticleUniverse::PrimitiveShapeSet::PrimitiveShapeSet ( void  )

Default constructor.

virtual ParticleUniverse::PrimitiveShapeSet::~PrimitiveShapeSet ( void  )
virtual

Default destructor.

Member Function Documentation

virtual void ParticleUniverse::PrimitiveShapeSet::_notifyCurrentCamera ( Camera cam)
virtual

Overridden from MovableObject

See also
MovableObject

Reimplemented from Ogre::MovableObject.

virtual void ParticleUniverse::PrimitiveShapeSet::_notifyResized ( void  )
virtual

Internal callback used by primitive shapes to notify their parent that they have been resized.

virtual void ParticleUniverse::PrimitiveShapeSet::_notifyZRotated ( void  )
virtual

Internal callback used by primitive shapes to notify their parent that they have been rotated around the Z-axis.

virtual const AxisAlignedBox& ParticleUniverse::PrimitiveShapeSet::getBoundingBox ( void  ) const
virtual

Overridden from MovableObject

See also
MovableObject

Implements Ogre::MovableObject.

virtual Real ParticleUniverse::PrimitiveShapeSet::getBoundingRadius ( void  ) const
virtual

Overridden from MovableObject

See also
MovableObject

Implements Ogre::MovableObject.

virtual const Ogre::LightList& ParticleUniverse::PrimitiveShapeSet::getLights ( void  ) const
virtual

Implements Ogre::Renderable.

virtual const Ogre::MaterialPtr& ParticleUniverse::PrimitiveShapeSet::getMaterial ( void  ) const
virtual

Overridden from MovableObject

See also
MovableObject

Implements Ogre::Renderable.

virtual const String& ParticleUniverse::PrimitiveShapeSet::getMaterialName ( void  ) const
virtual

Gets the name of the material to be used for this primitive shapeset.

virtual Real ParticleUniverse::PrimitiveShapeSet::getSquaredViewDepth ( const Camera cam) const
virtual

Overridden, see Renderable

Implements Ogre::Renderable.

virtual uint32 ParticleUniverse::PrimitiveShapeSet::getTypeFlags ( void  ) const
virtual

Override to return specific type flag

Reimplemented from Ogre::MovableObject.

virtual const Quaternion& ParticleUniverse::PrimitiveShapeSet::getWorldOrientation ( void  ) const
virtual

virtual const Vector3& ParticleUniverse::PrimitiveShapeSet::getWorldPosition ( void  ) const
virtual

virtual void ParticleUniverse::PrimitiveShapeSet::getWorldTransforms ( Ogre::Matrix4 xform) const
virtual

Overridden from MovableObject

See also
MovableObject

Implements Ogre::Renderable.

virtual bool ParticleUniverse::PrimitiveShapeSet::isCullIndividually ( void  ) const
virtual

Returns whether or not primitive shapes in this primitive shapeset are tested individually for culling.

virtual bool ParticleUniverse::PrimitiveShapeSet::isZRotated ( void  ) const
virtual

Returns true if the Z rotation has been set. This causes the textures to rotate.

virtual void ParticleUniverse::PrimitiveShapeSet::rotateTexture ( Real  speed)
virtual

Rotate Texture

virtual void ParticleUniverse::PrimitiveShapeSet::setCullIndividually ( bool  cullIndividual)
virtual

Sets whether culling tests primitive shapes in this primitive shapeset individually as well as in a group.

virtual void ParticleUniverse::PrimitiveShapeSet::setMaterialName ( const String name)
virtual

Sets the name of the material to be used for this primitive shapeset.

virtual void ParticleUniverse::PrimitiveShapeSet::setZRotated ( bool  zRotated)
virtual

Set indication whether the 'Z' rotation is activated. Z rotation is a 2D rotation effect and for a primitive shapeset implemented as a texture rotation.

virtual void ParticleUniverse::PrimitiveShapeSet::visitRenderables ( Ogre::Renderable::Visitor visitor,
bool  debugRenderables = false 
)
inlinevirtual
See also
MovableObject

Implements Ogre::MovableObject.

Member Data Documentation

AxisAlignedBox ParticleUniverse::PrimitiveShapeSet::mAABB
protected

Bounds of all billboards in this set

bool ParticleUniverse::PrimitiveShapeSet::mAllDefaultSize
protected

True if no primitive shape in this set has been resized - greater efficiency.

Real ParticleUniverse::PrimitiveShapeSet::mBoundingRadius
protected

Bounding radius

bool ParticleUniverse::PrimitiveShapeSet::mCullIndividual
protected

Flag indicating whether each billboard should be culled separately (default: false)

Camera* ParticleUniverse::PrimitiveShapeSet::mCurrentCamera
protected

Current camera

String ParticleUniverse::PrimitiveShapeSet::mMaterialName
protected

Name of the material to use

Ogre::MaterialPtr ParticleUniverse::PrimitiveShapeSet::mpMaterial
protected

Pointer to the material to use

bool ParticleUniverse::PrimitiveShapeSet::mWorldSpace
protected
bool ParticleUniverse::PrimitiveShapeSet::mZRotated
protected

Indication whether the Z rotation is active or not


The documentation for this class was generated from the following file: