Ogre::InstancedGeometry::GeometryBucket Class Reference

A GeometryBucket is a the lowest level bucket where geometry with the same vertex & index format is stored. More...

#include <OgreInstancedGeometry.h>

Inheritance diagram for Ogre::InstancedGeometry::GeometryBucket:

List of all members.

Public Types

typedef std::vector
< ShadowRenderable * > ShadowRenderableList

typedef
VectorIterator
< ShadowRenderableList > ShadowRenderableListIterator

Public Member Functions

GeometryBucket (MaterialBucket *parent, const String &formatString, const VertexData *vData, const IndexData *iData)

GeometryBucket (MaterialBucket *parent, const String &formatString, GeometryBucket *bucket)

virtual ~GeometryBucket ()

MaterialBucket * getParent (void)

Real getBoundingRadius (void) const

Retrieves the radius of the origin-centered bounding sphere for this object.

const VertexData * getVertexData (void) const

Get the vertex data for this geometry.

const IndexData * getIndexData (void) const

Get the index data for this geometry.

const MaterialPtr & getMaterial (void) const

Retrieves a weak reference to the material this renderable object uses.

Remarks:
Note that the Renderable also has the option to override the getTechnique method to specify a particular Technique to use instead of the best one available.

Technique * getTechnique (void) const

Retrieves a pointer to the Material Technique this renderable object uses.

void getWorldTransforms (Matrix4 *xform) const

Gets the world transform matrix / matrices for this renderable object.

virtual unsigned short getNumWorldTransforms (void) const

Returns the number of world transform matrices this renderable requires.

Real getSquaredViewDepth (const Camera *cam) const

Returns the camera-relative squared depth of this renderable.

const LightList & getLights (void) const

Gets a list of lights, ordered relative to how close they are to this renderable.

Remarks:
Directional lights, which have no position, will always be first on this list.

bool getCastsShadows (void) const

Method which reports whether this renderable would normally cast a shadow.

String getFormatString (void) const

bool assign (QueuedGeometry *qsm)

Try to assign geometry to this bucket.

void build ()

Build.

void dump (std::ofstream &of) const

Dump contents for diagnostics.

AxisAlignedBox & getAABB (void)

retun the BoundingBox information. Usefull when cloning the batch instance.

void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables)

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters:

visitor Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.

debugRenderables If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

void setMaterial (const String &matName)

virtual void setRenderOperation (const RenderOperation &rend)

virtual void getRenderOperation (RenderOperation &op)

Gets the render operation required to send this object to the frame buffer.

void setWorldTransform (const Matrix4 &xform)

virtual void _notifyCurrentCamera (Camera *cam)

Internal method to notify the object of the camera to be used for the next rendering operation.

void setBoundingBox (const AxisAlignedBox &box)

virtual const
AxisAlignedBox & getBoundingBox (void) const

Retrieves the local axis-aligned bounding box for this object.

virtual void _updateRenderQueue (RenderQueue *queue)

Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

virtual const String & getMovableType (void) const

Overridden from MovableObject.

virtual void _notifyCreator (MovableObjectFactory *fact)

Notify the object of it's creator (internal use only).

virtual
MovableObjectFactory * _getCreator (void) const

Get the creator of this object, if any (internal use only).

virtual void _notifyManager (SceneManager *man)

Notify the object of it's manager (internal use only).

virtual SceneManager * _getManager (void) const

Get the manager of this object, if any (internal use only).

virtual const String & getName (void) const

Returns the name of this object.

virtual Node * getParentNode (void) const

Returns the node to which this object is attached.

virtual SceneNode * getParentSceneNode (void) const

Returns the scene node to which this object is attached.

virtual void _notifyAttached (Node *parent, bool isTagPoint=false)

Internal method called to notify the object that it has been attached to a node.

virtual bool isAttached (void) const

Returns true if this object is attached to a SceneNode or TagPoint.

virtual void detatchFromParent (void)

Detaches an object from a parent SceneNode or TagPoint, if attached.

virtual bool isInScene (void) const

Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.

virtual void _notifyMoved (void)

Internal method called to notify the object that it has been moved.

virtual const
AxisAlignedBox & getWorldBoundingBox (bool derive=false) const

Retrieves the axis-aligned bounding box for this object in world coordinates.

virtual const Sphere & getWorldBoundingSphere (bool derive=false) const

Retrieves the worldspace bounding sphere for this object.

virtual void setVisible (bool visible)

Tells this object whether to be visible or not, if it has a renderable component.

virtual bool getVisible (void) const

Gets this object whether to be visible or not, if it has a renderable component.

virtual bool isVisible (void) const

Returns whether or not this object is supposed to be visible or not.

virtual void setRenderingDistance (Real dist)

Sets the distance at which the object is no longer rendered.

virtual Real getRenderingDistance (void) const

Gets the distance at which batches are no longer rendered.

virtual void setUserObject (UserDefinedObject *obj)

Call this to associate your own custom user object instance with this MovableObject.

virtual
UserDefinedObject * getUserObject (void)

Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject.

virtual void setUserAny (const Any &anything)

Sets any kind of user value on this object.

virtual void setUserAny (const Any &anything)

Sets any kind of user value on this object.

virtual const Any & getUserAny (void) const

Retrieves the custom user value associated with this object.

virtual const Any & getUserAny (void) const

Retrieves the custom user value associated with this object.

virtual void setRenderQueueGroup (uint8 queueID)

Sets the render queue group this entity will be rendered through.

virtual uint8 getRenderQueueGroup (void) const

Gets the queue group for this entity, see setRenderQueueGroup for full details.

virtual const Matrix4 & _getParentNodeFullTransform (void) const

return the full transformation of the parent sceneNode or the attachingPoint node

virtual void setQueryFlags (uint32 flags)

Sets the query flags for this object.

virtual void addQueryFlags (uint32 flags)

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

virtual void removeQueryFlags (unsigned long flags)

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

virtual uint32 getQueryFlags (void) const

Returns the query flags relevant for this object.

virtual void setVisibilityFlags (uint32 flags)

Sets the visiblity flags for this object.

virtual void addVisibilityFlags (uint32 flags)

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

virtual void removeVisibilityFlags (uint32 flags)

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

virtual uint32 getVisibilityFlags (void) const

Returns the visibility flags relevant for this object.

virtual void setListener (Listener *listener)

Sets a listener for this object.

virtual Listener * getListener (void) const

Gets the current listener for this object.

virtual const LightList & queryLights (void) const

Gets a list of lights, ordered relative to how close they are to this movable object.

virtual LightList * _getLightList ()

Returns a pointer to the current list of lights for this object.

EdgeData * getEdgeList (void)

Define a default implementation of method from ShadowCaster which implements no shadows.

bool hasEdgeList (void)

Define a default implementation of method from ShadowCaster which implements no shadows.

ShadowRenderableListIterator getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)

Define a default implementation of method from ShadowCaster which implements no shadows.

const AxisAlignedBox & getLightCapBounds (void) const

Overridden member from ShadowCaster.

const AxisAlignedBox & getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const

Overridden member from ShadowCaster.

void setCastShadows (bool enabled)

Sets whether or not this object will cast shadows.

bool getCastShadows (void) const

Returns whether shadow casting is enabled for this object.

Real getPointExtrusionDistance (const Light *l) const

Get the distance to extrude for a point/spot light.

virtual uint32 getTypeFlags (void) const

Get the 'type flags' for this MovableObject.

virtual void setDebugDisplayEnabled (bool enabled)

Sets whether or not the debug display of this object is enabled.

virtual bool isDebugDisplayEnabled (void) const

Gets whether debug display of this object is enabled.

const StringVector & getAnimableValueNames (void) const

Gets a list of animable value names for this object.

virtual AnimableValuePtr createAnimableValue (const String &valueName)

Create a reference-counted AnimableValuePtr for the named value.

void * operator new (size_t sz, const char *file, int line, const char *func)

operator new, with debug line info

void * operator new (size_t sz)

void * operator new (size_t sz, void *ptr)

placement operator new

void * operator new[] (size_t sz, const char *file, int line, const char *func)

array operator new, with debug line info

void * operator new[] (size_t sz)

void operator delete (void *ptr)

void operator delete (void *ptr, const char *, int, const char *)

void operator delete[] (void *ptr)

void operator delete[] (void *ptr, const char *, int, const char *)

virtual bool preRender (SceneManager *sm, RenderSystem *rsys)

Called just prior to the Renderable being rendered.

virtual void postRender (SceneManager *sm, RenderSystem *rsys)

Called immediately after the Renderable has been rendered.

void setUseIdentityProjection (bool useIdentityProjection)

Sets whether or not to use an 'identity' projection.

bool getUseIdentityProjection (void) const

Returns whether or not to use an 'identity' projection.

void setUseIdentityView (bool useIdentityView)

Sets whether or not to use an 'identity' view.

bool getUseIdentityView (void) const

Returns whether or not to use an 'identity' view.

void setCustomParameter (size_t index, const Vector4 &value)

Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

const Vector4 & getCustomParameter (size_t index) const

Gets the custom value associated with this Renderable at the given index.

virtual void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

virtual void setPolygonModeOverrideable (bool override)

Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

virtual bool getPolygonModeOverrideable (void) const

Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

virtual
RenderSystemData * getRenderSystemData () const

Sets render system private data.

virtual void setRenderSystemData (RenderSystemData *val) const

gets render system private data

Static Public Member Functions

static void setDefaultQueryFlags (uint32 flags)

Set the default query flags for all future MovableObject instances.

static uint32 getDefaultQueryFlags ()

Get the default query flags for all future MovableObject instances.

static void setDefaultVisibilityFlags (uint32 flags)

Set the default visibility flags for all future MovableObject instances.

static uint32 getDefaultVisibilityFlags ()

Get the default visibility flags for all future MovableObject instances.

static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)

Utility method for extruding vertices based on a light.

Protected Types

typedef std::map
< String,
StringVector > AnimableDictionaryMap

typedef std::map
< size_t, Vector4 > CustomParameterMap

Protected Member Functions

template<typename T>

void copyIndexes (const T *src, T *dst, size_t count, size_t indexOffset)

Real getExtrusionDistance (const Vector3 &objectPos, const Light *light) const

Helper method for calculating extrusion distance.

virtual void updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos)

Tells the caster to perform the tasks necessary to update the edge data's light listing.

virtual void generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags)

Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.

virtual void extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const

Utility method for extruding a bounding box.

virtual const String & getAnimableDictionaryName (void) const

Get the name of the animable dictionary for this class.

void createAnimableDictionary (void) const

Internal method for creating a dictionary of animable value names for the class, if it does not already exist.

StringVector & _getAnimableValueNames (void)

Get an updateable reference to animable value list.

virtual void initialiseAnimableDictionary (StringVector &) const

Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.

Protected Attributes

QueuedGeometryList mQueuedGeometry

Geometry which has been queued up pre-build (not for deallocation).

InstancedGeometry * mBatch

Pointer to the Batch.

MaterialBucket * mParent

Pointer to parent bucket.

String mFormatString

String identifying the vertex / index format.

VertexData * mVertexData

Vertex information, includes current number of vertices committed to be a part of this bucket.

IndexData * mIndexData

Index information, includes index type which limits the max number of vertices which are allowed in one bucket.

HardwareIndexBuffer::IndexType mIndexType

Size of indexes.

size_t mMaxVertexIndex

Maximum vertex indexable.

unsigned short mTexCoordIndex

Index of the Texcoord where the index is stored.

AxisAlignedBox mAABB

RenderOperation mRenderOp

Matrix4 m_matWorldTransform

AxisAlignedBox mBox

String m_strMatName

MaterialPtr m_pMaterial

SceneManager * m_pParentSceneManager

The scene manager for the current frame.

Camera * m_pCamera

The camera for the current frame.

String mName

Name of this object.

MovableObjectFactory * mCreator

Creator of this object (if created by a factory).

SceneManager * mManager

SceneManager holding this object (if applicable).

Node * mParentNode

node to which this object is attached

bool mParentIsTagPoint

bool mVisible

Is this object visible?

bool mDebugDisplay

Is debug display enabled?

Real mUpperDistance

Upper distance to still render.

Real mSquaredUpperDistance

bool mBeyondFarDistance

Hidden because of distance?

Any mUserAny

User defined link to another object / value / whatever.

Any mUserAny

uint8 mRenderQueueID

The render queue to use when rendering this object.

bool mRenderQueueIDSet

Flags whether the RenderQueue's default should be used.

uint32 mQueryFlags

Flags determining whether this object is included / excluded from scene queries.

uint32 mVisibilityFlags

Flags determining whether this object is visible (compared to SceneManager mask).

AxisAlignedBox mWorldAABB

Cached world AABB of this object.

Sphere mWorldBoundingSphere

AxisAlignedBox mWorldDarkCapBounds

World space AABB of this object's dark cap.

bool mCastShadows

Does this object cast shadows?

bool mRenderingDisabled

Does rendering this object disabled by listener?

Listener * mListener

MovableObject listener - only one allowed (no list) for size & performance reasons. */.

LightList mLightList

List of lights for this object.

ulong mLightListUpdated

The last frame that this light list was updated in.

CustomParameterMap mCustomParameters

bool mPolygonModeOverrideable

bool mUseIdentityProjection

bool mUseIdentityView

RenderSystemData * mRenderSystemData

Static Protected Attributes

static uint ms_uGenNameCount

Static member used to automatically generate names for SimpleRendaerable objects.

static uint32 msDefaultQueryFlags

Default query flags.

static uint32 msDefaultVisibilityFlags

Default visibility flags.

static
AnimableDictionaryMap msAnimableDictionary

Static map of class name to list of animable value names.

Detailed Description

A GeometryBucket is a the lowest level bucket where geometry with the same vertex & index format is stored.

It also acts as the renderable.

Definition at line 172 of file OgreInstancedGeometry.h.

Member Typedef Documentation

typedef std::vector<ShadowRenderable*> Ogre::ShadowCaster::ShadowRenderableList [inherited]

Definition at line 123 of file OgreShadowCaster.h.

typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator [inherited]

Definition at line 124 of file OgreShadowCaster.h.

typedef std::map<String, StringVector> Ogre::AnimableObject::AnimableDictionaryMap [protected, inherited]

Definition at line 234 of file OgreAnimable.h.

typedef std::map<size_t, Vector4> Ogre::Renderable::CustomParameterMap [protected, inherited]

Definition at line 371 of file OgreRenderable.h.

Constructor & Destructor Documentation

Ogre::InstancedGeometry::GeometryBucket::GeometryBucket	(	MaterialBucket *	parent,
		const String &	formatString,
		const VertexData *	vData,
		const IndexData *	iData
	)

Ogre::InstancedGeometry::GeometryBucket::GeometryBucket	(	MaterialBucket *	parent,
		const String &	formatString,
		GeometryBucket *	bucket
	)

virtual Ogre::InstancedGeometry::GeometryBucket::~GeometryBucket ( ) [virtual]

Member Function Documentation

template<typename T>

void Ogre::InstancedGeometry::GeometryBucket::copyIndexes	(	const T *	src,
		T *	dst,
		size_t	count,
		size_t	indexOffset
	)			`[protected]`

Definition at line 199 of file OgreInstancedGeometry.h.

MaterialBucket* Ogre::InstancedGeometry::GeometryBucket::getParent ( void )

Definition at line 218 of file OgreInstancedGeometry.h.

Real Ogre::InstancedGeometry::GeometryBucket::getBoundingRadius ( void ) const [virtual]

Retrieves the radius of the origin-centered bounding sphere for this object.

Implements Ogre::MovableObject.

const VertexData* Ogre::InstancedGeometry::GeometryBucket::getVertexData ( void ) const

Get the vertex data for this geometry.

Definition at line 221 of file OgreInstancedGeometry.h.

const IndexData* Ogre::InstancedGeometry::GeometryBucket::getIndexData ( void ) const

Get the index data for this geometry.

Definition at line 223 of file OgreInstancedGeometry.h.

const MaterialPtr& Ogre::InstancedGeometry::GeometryBucket::getMaterial ( void ) const [virtual]

Retrieves a weak reference to the material this renderable object uses.

Remarks:: Note that the Renderable also has the option to override the getTechnique method to specify a particular Technique to use instead of the best one available.

Reimplemented from Ogre::SimpleRenderable.

Technique* Ogre::InstancedGeometry::GeometryBucket::getTechnique ( void ) const [virtual]

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks:: This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented from Ogre::Renderable.

void Ogre::InstancedGeometry::GeometryBucket::getWorldTransforms ( Matrix4 * xform ) const [virtual]

Gets the world transform matrix / matrices for this renderable object.

Remarks:: If the object has any derived transforms, these are expected to be up to date as long as all the SceneNode structures have been updated before this is called.

: This method will populate xform with 1 matrix if it does not use vertex blending. If it does use vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from getNumWorldTransforms.

Note:: Internal Ogre never supports non-affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-affine matrix here.

See also:: Matrix4::isAffine.

Reimplemented from Ogre::SimpleRenderable.

virtual unsigned short Ogre::InstancedGeometry::GeometryBucket::getNumWorldTransforms ( void ) const [virtual]

Returns the number of world transform matrices this renderable requires.

Remarks:: When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented from Ogre::Renderable.

Real Ogre::InstancedGeometry::GeometryBucket::getSquaredViewDepth ( const Camera * cam ) const [virtual]

Returns the camera-relative squared depth of this renderable.

Remarks:: Used to sort transparent objects. Squared depth is used rather than actual depth to avoid having to perform a square root on the result.

Implements Ogre::Renderable.

const LightList& Ogre::InstancedGeometry::GeometryBucket::getLights ( void ) const [virtual]

Gets a list of lights, ordered relative to how close they are to this renderable.

Remarks:: Directional lights, which have no position, will always be first on this list.

Reimplemented from Ogre::SimpleRenderable.

bool Ogre::InstancedGeometry::GeometryBucket::getCastsShadows ( void ) const [virtual]

Method which reports whether this renderable would normally cast a shadow.

Remarks:: Subclasses should override this if they could have been used to generate a shadow.

Reimplemented from Ogre::Renderable.

String Ogre::InstancedGeometry::GeometryBucket::getFormatString ( void ) const

bool Ogre::InstancedGeometry::GeometryBucket::assign ( QueuedGeometry * qsm )

Try to assign geometry to this bucket.

Returns:: false if there is no room left in this bucket

void Ogre::InstancedGeometry::GeometryBucket::build ( )

Build.

void Ogre::InstancedGeometry::GeometryBucket::dump ( std::ofstream & of ) const

Dump contents for diagnostics.

AxisAlignedBox& Ogre::InstancedGeometry::GeometryBucket::getAABB ( void )

retun the BoundingBox information. Usefull when cloning the batch instance.

Definition at line 242 of file OgreInstancedGeometry.h.

void Ogre::InstancedGeometry::GeometryBucket::visitRenderables	(	Renderable::Visitor *	visitor,
		bool	debugRenderables
	)			`[virtual]`

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters:

	visitor	Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
	debugRenderables	If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Reimplemented from Ogre::SimpleRenderable.

void Ogre::SimpleRenderable::setMaterial ( const String & matName ) [inherited]

virtual void Ogre::SimpleRenderable::setRenderOperation ( const RenderOperation & rend ) [virtual, inherited]

virtual void Ogre::SimpleRenderable::getRenderOperation ( RenderOperation & op ) [virtual, inherited]

Gets the render operation required to send this object to the frame buffer.

Implements Ogre::Renderable.

void Ogre::SimpleRenderable::setWorldTransform ( const Matrix4 & xform ) [inherited]

virtual void Ogre::SimpleRenderable::_notifyCurrentCamera ( Camera * cam ) [virtual, inherited]

Internal method to notify the object of the camera to be used for the next rendering operation.

Remarks:: Certain objects may want to do specific processing based on the camera position. This method notifies them in case they wish to do this.

Reimplemented from Ogre::MovableObject.

void Ogre::SimpleRenderable::setBoundingBox ( const AxisAlignedBox & box ) [inherited]

virtual const AxisAlignedBox& Ogre::SimpleRenderable::getBoundingBox ( void ) const [virtual, inherited]

Retrieves the local axis-aligned bounding box for this object.

Remarks:: This bounding box is in local coordinates.

Implements Ogre::MovableObject.

virtual void Ogre::SimpleRenderable::_updateRenderQueue ( RenderQueue * queue ) [virtual, inherited]

Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

Remarks:: The engine will call this method when this object is to be rendered. The object must then create one or more Renderable subclass instances which it places on the passed in Queue for rendering.

Implements Ogre::MovableObject.

virtual const String& Ogre::SimpleRenderable::getMovableType ( void ) const [virtual, inherited]

Overridden from