Ogre::InstancedEntity Class Reference
[Scene]

#include <OgreInstancedEntity.h>

Inheritance diagram for Ogre::InstancedEntity:

[legend]

Public Types
typedef vector < ShadowRenderable * >::type	ShadowRenderableList
typedef VectorIterator < ShadowRenderableList >	ShadowRenderableListIterator
Public Member Functions
	InstancedEntity (InstanceBatch batchOwner, uint32 instanceID, InstancedEntity sharedTransformEntity=NULL)
virtual	~InstancedEntity ()
bool	shareTransformWith (InstancedEntity *slave)
	Shares the entire transformation with another InstancedEntity.
void	stopSharingTransform ()
InstanceBatch *	_getOwner () const
const String &	getMovableType (void) const
	Returns the type name of this object.
const AxisAlignedBox &	getBoundingBox (void) const
	Retrieves the local axis-aligned bounding box for this object.
Real	getBoundingRadius (void) const
	Retrieves the radius of the origin-centered bounding sphere for this object.
Real	getSquaredViewDepth (const Camera *cam) const
	This is used by our batch owner to get the closest entity's depth, returns infinity when not attached to a scene node.
void	_notifyMoved (void)
	Overriden so we can tell the InstanceBatch it needs to update it's bounds.
void	_notifyAttached (Node *parent, bool isTagPoint=false)
	Internal method called to notify the object that it has been attached to a node.
void	_updateRenderQueue (RenderQueue *queue)
	Do nothing, InstanceBatch takes care of this.
void	visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
	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.
bool	hasSkeleton (void) const
SkeletonInstance *	getSkeleton (void) const
AnimationState *	getAnimationState (const String &name) const
AnimationStateSet *	getAllAnimationStates (void) const
virtual bool	_updateAnimation (void)
	Called by InstanceBatch in his _updateRenderQueue to tell us we need to calculate our bone matrices.
void	setTransformLookupNumber (uint16 num)
	Sets the transformation look up number.
const Vector3 &	getPosition () const
	Retrieve the position.
void	setPosition (const Vector3 &position, bool doUpdate=true)
	Set the position or the offset from the parent node if a parent node exists.
const Quaternion &	getOrientation () const
	Retrieve the orientation.
void	setOrientation (const Quaternion &orientation, bool doUpdate=true)
	Set the orientation or the offset from the parent node if a parent node exists.
const Vector3 &	getScale () const
	Retrieve the local scale.
void	setScale (const Vector3 &scale, bool doUpdate=true)
	Set the scale or the offset from the parent node if a parent node exists.
Real	getMaxScaleCoef () const
	Returns the maximum derived scale coefficient among the xyz values.
void	updateTransforms ()
	Update the world transform and derived values.
bool	isInUse () const
	Tells if the entity is in use.
void	setInUse (bool used)
	Sets whether the entity is in use.
virtual const Matrix4 &	_getParentNodeFullTransform (void) const
	Returns the world transform of the instanced entity including local transform.
const Vector3 &	_getDerivedPosition () const
	Returns the derived position of the instanced entity including local transform.
virtual bool	isInScene (void) const
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 bool	isParentTagPoint () const
	Gets whether the parent node is a TagPoint (or a SceneNode).
virtual bool	isAttached (void) const
	Returns true if this object is attached to a SceneNode or TagPoint.
virtual void	detachFromParent (void)
	Detaches an object from a parent SceneNode or TagPoint, if attached.
virtual void	_notifyCurrentCamera (Camera *cam)
	Internal method to notify the object of the camera to be used for the next rendering operation.
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	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
virtual Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
virtual void	setUserAny (const Any &anything)
virtual const Any &	getUserAny (void) const
UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class.
const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class.
virtual void	setRenderQueueGroup (uint8 queueID)
	Sets the render queue group this entity will be rendered through.
virtual void	setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
	Sets the render queue group and group priority this entity will be rendered through.
virtual uint8	getRenderQueueGroup (void) const
	Gets the queue group for this entity, see setRenderQueueGroup for full details.
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 (uint32 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 uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object.
virtual void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this 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.
bool	getReceivesShadows ()
	Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
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, void )
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 *)
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 vector < InstancedEntity * >::type	InstancedEntityVec
	Stores the master when we're the slave, store our slaves when we're the master.
typedef map< String, StringVector >::type	AnimableDictionaryMap
Protected Member Functions
size_t	getTransforms (Matrix4 *xform) const
	Returns number of matrices written to transform, assumes transform has enough space.
size_t	getTransforms3x4 (float *xform) const
	Returns number of 32-bit values written.
bool	findVisible (Camera *camera) const
	Returns true if this InstancedObject is visible to the current camera.
void	createSkeletonInstance ()
	Creates/destroys our own skeleton, also tells slaves to unlink if we're destroying.
void	destroySkeletonInstance ()
void	unlinkTransform ()
	Just unlinks, and tells our master we're no longer sharing.
void	notifyUnlink (const InstancedEntity *slave)
	Called when a slave has unlinked from us.
void	markTransformDirty ()
	Mark the transformation matrixes as dirty.
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
uint16	mInstanceId
bool	mInUse
InstanceBatch *	mBatchOwner
AnimationStateSet *	mAnimationState
SkeletonInstance *	mSkeletonInstance
Matrix4 *	mBoneMatrices
Matrix4 *	mBoneWorldMatrices
unsigned long	mFrameAnimationLastUpdated
InstancedEntity *	mSharedTransformEntity
uint16	mTransformLookupNumber
	Used in conjunction with bone matrix lookup.
InstancedEntityVec	mSharingPartners
Vector3	mPosition
	Object position.
Vector3	mDerivedLocalPosition
Quaternion	mOrientation
	Object orientation.
Vector3	mScale
	Object scale.
Real	mMaxScaleLocal
	The maximum absolute scale for all dimension.
Matrix4	mFullLocalTransform
	Full world transform.
bool	mNeedTransformUpdate
	Tells if mFullTransform needs an updated.
bool	mNeedAnimTransformUpdate
	Tells if the animation world transform needs an update.
bool	mUseLocalTransform
	Tells whether to use the local transform parameters.
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
Real	mMinPixelSize
bool	mBeyondFarDistance
	Hidden because of distance?
UserObjectBindings	mUserObjectBindings
	User objects binding.
uint8	mRenderQueueID
	The render queue to use when rendering this object.
bool	mRenderQueueIDSet
	Flags whether the RenderQueue's default should be used.
ushort	mRenderQueuePriority
	The render queue group to use when rendering this object.
bool	mRenderQueuePrioritySet
	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.
uint32	mLightMask
	the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable
Static Protected Attributes
static NameGenerator	msNameGenerator
	Incremented count for next name extension.
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.
Friends
class	InstanceBatch
class	InstanceBatchShader
class	InstanceBatchHW
class	InstanceBatchHW_VTF
class	BaseInstanceBatchVTF

Detailed Description

See also:: InstanceBatch to understand how instancing works.

Instanced entities work in a very similar way as how an Entity works, as this interface tries to mimic it as most as possible to make the transition between Entity and InstancedEntity as straightforward and simple as possible. There are a couple inherent limitations, for example setRenderQueueGroup only works on the InstanceBatch level, not the individual instance. This limits Z sorting for alpha blending quite significantly An InstancedEntity won't appear in scene until a SceneNode is attached to them. Once the InstancedEntity is no longer needed, call InstanceBatch::removeInstancedEntity to put them back into a queue so the batch can return it back again when a new instance is requested.

: Internally, instanced entities that are not visible (i.e. by setting setVisible(false) or when they don't have a SceneNode attached to them) a Zero world matrix is sent to the vertex shader which in turn causes a zero area triangle. This obviously means no Vertex shader benefit, but saves a bit of pixel shader processing power. Also this means this object won't be considered when sizing the InstanceBatch's bounding box.

: Each instance has an instance ID unique within the batch, which matches the ID sent to the vertex shader by some techniques (like InstanceBatchShader).

: Differences between Entity and InstancedEntity: Setting RenderQueueGroup and other Renderable stuff works at InstanceBatch level, not InstancedEntity. This is obviously a limitation from instancing in general, not this particular implementation

Remarks:: Design discussion webpage

Author:: Matias N. Goldberg ("dark_sylinc")

Version:: 1.0

Definition at line 76 of file OgreInstancedEntity.h.

Member Typedef Documentation

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

Definition at line 240 of file OgreAnimable.h.

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

Definition at line 135 of file OgreShadowCaster.h.

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

Definition at line 136 of file OgreShadowCaster.h.

Member Function Documentation

StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void ) [protected, inherited]

Get an updateable reference to animable value list.

Definition at line 266 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND.

virtual MovableObjectFactory* Ogre::MovableObject::_getCreator ( void ) const [virtual, inherited]

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

Definition at line 185 of file OgreMovableObject.h.

virtual LightList* Ogre::MovableObject::_getLightList ( ) [virtual, inherited]

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

Remarks:: You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

Definition at line 490 of file OgreMovableObject.h.

virtual SceneManager* Ogre::MovableObject::_getManager ( void ) const [virtual, inherited]

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

Definition at line 189 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyCreator ( MovableObjectFactory * fact ) [virtual, inherited]

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

Definition at line 183 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_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 in Ogre::BillboardChain, Ogre::BillboardSet, Ogre::Entity, Ogre::Frustum, Ogre::InstanceBatch, Ogre::InstancedGeometry::BatchInstance, Ogre::MovablePlane, Ogre::ParticleSystem, Ogre::SimpleRenderable, and Ogre::StaticGeometry::Region.

virtual void Ogre::MovableObject::_notifyManager ( SceneManager * man ) [virtual, inherited]

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

Definition at line 187 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::addQueryFlags ( uint32 flags ) [virtual, inherited]

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

Definition at line 395 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::addVisibilityFlags ( uint32 flags ) [virtual, inherited]

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

Definition at line 423 of file OgreMovableObject.h.

void Ogre::AnimableObject::createAnimableDictionary ( void ) const [protected, inherited]

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

Definition at line 253 of file OgreAnimable.h.

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String & valueName ) [virtual, inherited]

Create a reference-counted AnimableValuePtr for the named value.

Remarks:: You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 319 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND.

virtual void Ogre::MovableObject::detachFromParent ( void ) [virtual, inherited]

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

virtual void Ogre::ShadowCaster::extrudeBounds	(	AxisAlignedBox &	box,
		const Vector4 &	lightPos,
		Real	extrudeDist
	)			const `[protected, virtual, inherited]`

Utility method for extruding a bounding box.

Parameters:

	box	Original bounding box, will be updated in-place
	lightPos	4D light position in object space, when w=0.0f this represents a directional light
	extrudeDist	The distance to extrude

static void Ogre::ShadowCaster::extrudeVertices	(	const HardwareVertexBufferSharedPtr &	vertexBuffer,
		size_t	originalVertexCount,
		const Vector4 &	lightPos,
		Real	extrudeDist
	)			`[static, inherited]`

Utility method for extruding vertices based on a light.

Remarks:: Unfortunately, because D3D cannot handle homogeneous (4D) position coordinates in the fixed-function pipeline (GL can, but we have to be cross-API), when we extrude in software we cannot extrude to infinity the way we do in the vertex program (by setting w to 0.0f). Therefore we extrude by a fixed distance, which may cause some problems with larger scenes. Luckily better hardware (ie vertex programs) can fix this.

Parameters:

	vertexBuffer	The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
	originalVertexCount	The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
	lightPos	4D light position in object space, when w=0.0f this represents a directional light
	extrudeDist	The distance to extrude

virtual void Ogre::ShadowCaster::generateShadowVolume	(	EdgeData *	edgeData,
		const HardwareIndexBufferSharedPtr &	indexBuffer,
		const Light *	light,
		ShadowRenderableList &	shadowRenderables,
		unsigned long	flags
	)			`[protected, virtual, inherited]`

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

Parameters:

	edgeData	The edge information to use
	indexBuffer	The buffer into which to write data into; current contents are assumed to be discardable.
	light	The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing
	shadowRenderables	A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used.
	flags	Additional controller flags, see ShadowRenderableFlags

virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void ) const [protected, virtual, inherited]

Get the name of the animable dictionary for this class.

Remarks:: Subclasses must override this if they want to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 248 of file OgreAnimable.h.

References Ogre::StringUtil::BLANK.

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void ) const [inherited]

Gets a list of animable value names for this object.

Definition at line 294 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND.

bool Ogre::MovableObject::getCastShadows ( void ) const [virtual, inherited]

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 520 of file OgreMovableObject.h.

const AxisAlignedBox& Ogre::MovableObject::getDarkCapBounds	(	const Light &	light,
		Real	dirLightExtrusionDist
	)			const `[virtual, inherited]`

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( ) [static, inherited]

Get the default query flags for all future MovableObject instances.

Definition at line 410 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( ) [static, inherited]

Get the default visibility flags for all future MovableObject instances.

Definition at line 438 of file OgreMovableObject.h.

EdgeData* Ogre::MovableObject::getEdgeList ( void ) [virtual, inherited]

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, Ogre::ManualObject, and Ogre::StaticGeometry::Region.

Definition at line 493 of file OgreMovableObject.h.

Real Ogre::ShadowCaster::getExtrusionDistance	(	const Vector3 &	objectPos,
		const Light *	light
	)			const `[protected, inherited]`

Helper method for calculating extrusion distance.

const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds ( void ) const [virtual, inherited]

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

virtual uint32 Ogre::MovableObject::getLightMask ( ) const [virtual, inherited]

Get a bitwise mask which will filter the lights affecting this object.

Remarks:: By default, this mask is fully set meaning all lights will affect this object

Definition at line 475 of file OgreMovableObject.h.

virtual Listener* Ogre::MovableObject::getListener ( void ) const [virtual, inherited]

Gets the current listener for this object.

Definition at line 449 of file OgreMovableObject.h.

virtual const String& Ogre::MovableObject::getName ( void ) const [virtual, inherited]

Returns the name of this object.

Definition at line 192 of file OgreMovableObject.h.

virtual Node* Ogre::MovableObject::getParentNode ( void ) const [virtual, inherited]

Returns the node to which this object is attached.

Remarks:: A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. Both are Node subclasses so this method will return either.

virtual SceneNode* Ogre::MovableObject::getParentSceneNode ( void ) const [virtual, inherited]

Returns the scene node to which this object is attached.

Remarks:: A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. This method will return the scene node of the parent entity if the latter is true.

Real Ogre::MovableObject::getPointExtrusionDistance ( const Light * l ) const [virtual, inherited]

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

Implements Ogre::ShadowCaster.

virtual uint32 Ogre::MovableObject::getQueryFlags ( void ) const [virtual, inherited]

Returns the query flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 402 of file OgreMovableObject.h.

bool Ogre::MovableObject::getReceivesShadows ( ) [inherited]

Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.

virtual Real Ogre::MovableObject::getRenderingDistance ( void ) const [virtual, inherited]

Gets the distance at which batches are no longer rendered.

Definition at line 304 of file OgreMovableObject.h.

virtual Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const [virtual, inherited]

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Definition at line 317 of file OgreMovableObject.h.

virtual uint8 Ogre::MovableObject::getRenderQueueGroup ( void ) const [virtual, inherited]

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

ShadowRenderableListIterator Ogre::MovableObject::getShadowVolumeRenderableIterator	(	ShadowTechnique	shadowTechnique,
		const Light *	light,
		HardwareIndexBufferSharedPtr *	indexBuffer,
		bool	extrudeVertices,
		Real	extrusionDist,
		unsigned long	flags = `0`
	)			`[virtual, inherited]`

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, Ogre::ManualObject, and Ogre::StaticGeometry::Region.

virtual uint32 Ogre::MovableObject::getTypeFlags ( void ) const [virtual, inherited]

Get the 'type flags' for this MovableObject.

Remarks:: A type flag identifies the type of the MovableObject as a bitpattern. This is used for categorical inclusion / exclusion in SceneQuery objects. By default, this method returns all ones for objects not created by a MovableObjectFactory (hence always including them); otherwise it returns the value assigned to the MovableObjectFactory. Custom objects which don't use MovableObjectFactory will need to override this if they want to be included in queries.

Reimplemented in Ogre::BillboardSet, Ogre::Entity, Ogre::Frustum, Ogre::Light, Ogre::ParticleSystem, and Ogre::StaticGeometry::Region.

virtual const Any& Ogre::MovableObject::getUserAny ( void ) const [virtual, inherited]

Deprecated:: use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 333 of file OgreMovableObject.h.

const UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) const [inherited]

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also:: UserObjectBindings::setUserAny.

Definition at line 345 of file OgreMovableObject.h.

UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) [inherited]

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also:: UserObjectBindings::setUserAny.

Definition at line 339 of file OgreMovableObject.h.

virtual uint32 Ogre::MovableObject::getVisibilityFlags ( void ) const [virtual, inherited]

Returns the visibility flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 430 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::getVisible ( void ) const [virtual, inherited]

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

Remarks:: Returns the value set by MovableObject::setVisible only.

virtual const AxisAlignedBox& Ogre::MovableObject::getWorldBoundingBox ( bool derive = false ) const [virtual, inherited]

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity.

virtual const Sphere& Ogre::MovableObject::getWorldBoundingSphere ( bool derive = false ) const [virtual, inherited]

Retrieves the worldspace bounding sphere for this object.

Reimplemented in Ogre::Entity.

bool Ogre::MovableObject::hasEdgeList ( void ) [virtual, inherited]

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, Ogre::ManualObject, and Ogre::StaticGeometry::Region.

Definition at line 495 of file OgreMovableObject.h.

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector & ) const [protected, virtual, inherited]

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

Reimplemented in Ogre::Light.

Definition at line 286 of file OgreAnimable.h.

virtual bool Ogre::MovableObject::isAttached ( void ) const [virtual, inherited]

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

virtual bool Ogre::MovableObject::isDebugDisplayEnabled ( void ) const [virtual, inherited]

Gets whether debug display of this object is enabled.

Definition at line 564 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::isParentTagPoint ( ) const [virtual, inherited]

Gets whether the parent node is a TagPoint (or a SceneNode).

Definition at line 215 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::isVisible ( void ) const [virtual, inherited]

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

Remarks:: Takes into account both upper rendering distance and visible flag.

Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			`[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			`[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 90 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

virtual const LightList& Ogre::MovableObject::queryLights ( void ) const [virtual, inherited]

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

Remarks:: By default, this method gives the listener a chance to populate light list first, if there is no listener or Listener::objectQueryLights returns NULL, it'll query the light list from parent entity if it is present, or returns SceneNode::findLights if it has parent scene node, otherwise it just returns an empty list.

: The object internally caches the light list, so it will recalculate it only when object is moved, or lights that affect the frustum have been changed (

See also:: SceneManager::_getLightsDirtyCounter), but if listener exists, it will be called each time, so the listener should implement their own cache mechanism to optimise performance.

: This method can be useful when implementing Renderable::getLights in case the renderable is a part of the movable.

Returns:: The list of lights use to lighting this object.

virtual void Ogre::MovableObject::removeQueryFlags ( uint32 flags ) [virtual, inherited]

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

Definition at line 399 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::removeVisibilityFlags ( uint32 flags ) [virtual, inherited]

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

Definition at line 427 of file OgreMovableObject.h.

void Ogre::MovableObject::setCastShadows ( bool enabled ) [inherited]

Sets whether or not this object will cast shadows.

Remarks:: This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.

Note:: This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

Definition at line 518 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setDebugDisplayEnabled ( bool enabled ) [virtual, inherited]

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

Remarks:: Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

Definition at line 562 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32 flags ) [static, inherited]

Set the default query flags for all future MovableObject instances.

Definition at line 406 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32 flags ) [static, inherited]

Set the default visibility flags for all future MovableObject instances.

Definition at line 434 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setLightMask ( uint32 lightMask ) [virtual, inherited]

Set a bitwise mask which will filter the lights affecting this object.

Remarks:: This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object

virtual void Ogre::MovableObject::setListener ( Listener * listener ) [virtual, inherited]

Sets a listener for this object.

Remarks:: Note for size and performance reasons only one listener per object is allowed.

Definition at line 445 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setQueryFlags ( uint32 flags ) [virtual, inherited]

Sets the query flags for this object.

Remarks:: When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.

Definition at line 391 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderingDistance ( Real dist ) [virtual, inherited]

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

Note:: Camera::setUseRenderingDistance() needs to be called for this parameter to be used.

Parameters:

dist

Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

Definition at line 298 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderingMinPixelSize ( Real pixelSize ) [virtual, inherited]

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note:: Camera::setUseMinPixelSize() needs to be called for this parameter to be used.

Parameters:

pixelSize

Number of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 311 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderQueueGroup ( uint8 queueID ) [virtual, inherited]

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

Remarks:: Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

: See RenderQueue for more details.

Parameters:

queueID

Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

Reimplemented in Ogre::Entity, and Ogre::ParticleSystem.

virtual void Ogre::MovableObject::setRenderQueueGroupAndPriority	(	uint8	queueID,
		ushort	priority
	)			`[virtual, inherited]`

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

Remarks:: Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.

: See RenderQueue for more details.

Parameters:

	queueID	Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
	priority	The priority within a group to use.

Reimplemented in Ogre::Entity.

virtual void Ogre::MovableObject::setUserAny ( const Any & anything ) [virtual, inherited]

Deprecated:: use UserObjectBindings::setUserAny via getUserObjectBindings() instead. Sets any kind of user value on this object.

Remarks:: This method allows you to associate any user value you like with this MovableObject. This can be a pointer back to one of your own classes for instance.

Definition at line 328 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setVisibilityFlags ( uint32 flags ) [virtual, inherited]

Sets the visiblity flags for this object.

Remarks:: As well as a simple true/false value for visibility (as seen in setVisible), you can also set visiblity flags which when 'and'ed with the SceneManager's visibility mask can also make an object invisible.

Definition at line 419 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setVisible ( bool visible ) [virtual, inherited]

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

Note:: An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.

Reimplemented in Ogre::Light.