OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::InstancedEntity Class Reference

#include <OgreInstancedEntity.h>

+ Inheritance diagram for Ogre::InstancedEntity:
+ Collaboration diagram for Ogre::InstancedEntity:

Public Types

typedef FastArray
< MovableObject * > 
MovableObjectArray
 SceneManager::cullFrustum More...
 

Public Member Functions

 InstancedEntity (IdType id, ObjectMemoryManager *objectMemoryManager, InstanceBatch *batchOwner, uint32 instanceID, BoneMemoryManager *boneMemoryManager, InstancedEntity *sharedTransformEntity=NULL)
 
virtual ~InstancedEntity ()
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
ObjectData_getObjectData ()
 Returns a direct access to the ObjectData state. More...
 
InstanceBatch_getOwner () const
 
const Matrix4_getParentNodeFullTransform (void) const
 Returns the full transformation of the parent sceneNode or the attachingPoint node. More...
 
virtual void _notifyAttached (Node *parent)
 Overloaded so we can register ourselves for updating our animations. More...
 
void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _notifyParentNodeMemoryChanged (void)
 Node::_callMemoryChangeListeners More...
 
virtual void _notifyStaticDirty (void) const
 Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly. More...
 
void _setCachedAabbOutOfDate (void)
 
void _updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera)
 Do nothing, InstanceBatch takes care of this. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode if attached. More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 
const AxisAlignedBoxgetBoundingBox (void) const
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
const FastArray< unsigned char > & getCurrentMaterialLod (void) const
 
const Vector4getCustomParam (unsigned char idx)
 
IdType getId () const
 Get the unique id of this object. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
Aabb getLocalAabb (void) const
 Retrieves the local axis-aligned bounding box for this object. More...
 
const StringgetMovableType (void) const
 Returns the type name of this object. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 
uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
Real getRenderingMinPixelSize () const
 Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
 
SkeletonInstancegetSkeleton (void) const
 
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. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
Aabb getWorldAabb () const
 Gets the axis aligned box in world space. More...
 
Aabb getWorldAabbUpdated ()
 Gets the axis aligned box in world space. More...
 
float getWorldRadius () const
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
float getWorldRadiusUpdated ()
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
bool hasSkeleton (void) const
 
virtual void instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags)
 InstancingTheadedCullingMethod, More...
 
bool isAttached (void) const
 Returns true if this object is attached to a Node. More...
 
bool isCachedAabbOutOfDate () const
 
virtual bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled. More...
 
virtual bool isInScene (void) const
 
bool isInUse () const
 Tells if the entity is in use. More...
 
bool isStatic () const
 Checks whether this MovableObject is static. setStatic. More...
 
bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. More...
 
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 *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
bool operator() (const IdObject *left, const IdObject *right)
 
bool operator() (const IdObject &left, const IdObject &right)
 
const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
void setCustomParam (unsigned char idx, const Vector4 &newParam)
 Sets the custom parameter for this instance. More...
 
virtual void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setLocalAabb (const Aabb box)
 Sets the local axis-aligned bounding box for this object. More...
 
void setName (const String &name)
 Sets a custom name for this node. More...
 
void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
void setRenderingMinPixelSize (Real pixelSize)
 Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
virtual void setRenderQueueGroup (uint8 queueID)
 Sets the render queue group this entity will be rendered through. More...
 
virtual void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 Sets the render queue group and group priority this entity will be rendered through. More...
 
bool setStatic (bool bStatic)
 Turns this Node into static or dynamic. More...
 
void setTransformLookupNumber (uint16 num)
 Sets the transformation look up number. More...
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
bool shareTransformWith (InstancedEntity *slave)
 Shares the entire transformation with another InstancedEntity. More...
 
void stopSharingTransform ()
 
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. More...
 

Static Public Member Functions

static void buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
 SceneManager::buildLightList More...
 
static void calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox)
 
static void cullFrustum (const size_t numNodes, ObjectData t, const Frustum *frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera *lodCamera)
 
static void cullLights (const size_t numNodes, ObjectData t, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
 SceneManager::cullLights & More...
 
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances. More...
 
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances. More...
 
static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances. More...
 
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances. More...
 
static void updateAllBounds (const size_t numNodes, ObjectData t)
 SceneManager::updateAllBounds More...
 

Public Attributes

const FastArray< Realc_DefaultLodMesh
 
size_t mGlobalIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 
size_t mParentIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 

Protected Types

typedef map< String,
StringVector >::type 
AnimableDictionaryMap
 
typedef vector
< InstancedEntity * >::type 
InstancedEntityVec
 Stores the master when we're the slave, store our slaves when we're the master. More...
 

Protected Member Functions

StringVector_getAnimableValueNames (void)
 Get an updateable reference to animable value list. More...
 
void _setId (IdType newId)
 In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private). More...
 
void createAnimableDictionary (void) const
 Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More...
 
void createSkeletonInstance ()
 Creates/destroys our own skeleton, also tells slaves to unlink if we're destroying. More...
 
void destroySkeletonInstance ()
 
bool findVisible (Camera *camera) const
 Returns true if this InstancedObject is visible to the current camera. More...
 
virtual const StringgetAnimableDictionaryName (void) const
 Get the name of the animable dictionary for this class. More...
 
size_t getTransforms (Matrix4 *xform) const
 Returns number of matrices written to transform, assumes transform has enough space. More...
 
size_t getTransforms3x4 (float *xform) const
 Returns number of 32-bit values written. More...
 
virtual void initialiseAnimableDictionary (StringVector &) const
 Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More...
 
void notifyUnlink (const InstancedEntity *slave)
 Called when a slave has unlinked from us. More...
 
void setInUse (bool used)
 Sets whether the entity is in use. More...
 
void stopSharingTransformAsSlave (bool notifyMaster)
 When this entity is a slave, stopSharingTransform delegates to this function. More...
 
void unlinkTransform (bool notifyMaster=true)
 Just unlinks, and tells our master we're no longer sharing. More...
 
Aabb updateSingleWorldAabb ()
 
float updateSingleWorldRadius ()
 
FORCEINLINE void writeAnimatedTransform3x4 (float *RESTRICT_ALIAS xform, Mesh::IndexMap::const_iterator boneIdxStart, Mesh::IndexMap::const_iterator boneIdxEnd) const
 Fills xform with 4x3 world matrices from skeletal animation (12 bytes each) More...
 
FORCEINLINE void writeDualQuatTransform (float *RESTRICT_ALIAS xform, Mesh::IndexMap::const_iterator boneIdxStart, Mesh::IndexMap::const_iterator boneIdxEnd) const
 Fills xform with Dual Quaternion matrices from skeletal animation (32 bytes each) More...
 
FORCEINLINE void writeLutTransform3x4 (float *RESTRICT_ALIAS xform, Mesh::IndexMap::const_iterator boneIdxStart, Mesh::IndexMap::const_iterator boneIdxEnd) const
 Fills xform with 4x3 world matrices from skeletal animation (12 bytes each, LUT) More...
 
FORCEINLINE void writeSingleTransform3x4 (float *RESTRICT_ALIAS xform) const
 Fills xform with the 4x3 world matrix (12 bytes) More...
 

Protected Attributes

InstanceBatchmBatchOwner
 
BoneMemoryManagermBoneMemoryManager
 
bool mCachedAabbOutOfDate
 
FastArray< unsigned char > mCurrentMaterialLod
 
unsigned char mCurrentMeshLod
 
bool mDebugDisplay
 Is debug display enabled? More...
 
uint16 mInstanceId
 
bool mInUse
 
LightList mLightList
 List of lights for this object. More...
 
ListenermListener
 MovableObject listener - only one allowed (no list) for size & performance reasons. More...
 
FastArray< FastArray< Real >
const * > 
mLodMaterial
 
FastArray< Real > const * mLodMesh
 
SceneManagermManager
 SceneManager holding this object (if applicable) More...
 
Real mMinPixelSize
 Minimum pixel size to still render. More...
 
String mName
 Friendly name of this object, can be empty. More...
 
ObjectData mObjectData
 All the object data needed in SoA form. More...
 
ObjectMemoryManagermObjectMemoryManager
 The memory manager used to allocate the ObjectData. More...
 
NodemParentNode
 Node to which this object is attached. More...
 
uint8 mRenderQueueID
 The render queue to use when rendering this object. More...
 
ushort mRenderQueuePriority
 The render queue group to use when rendering this object. More...
 
InstancedEntitymSharedTransformEntity
 
InstancedEntityVec mSharingPartners
 
SkeletonInstancemSkeletonInstance
 
uint16 mTransformLookupNumber
 Used in conjunction with bone matrix lookup. More...
 
UserObjectBindings mUserObjectBindings
 User objects binding. More...
 

Static Protected Attributes

static AnimableDictionaryMap msAnimableDictionary
 Static map of class name to list of animable value names. More...
 
static uint32 msDefaultQueryFlags
 Default query flags. More...
 
static uint32 msDefaultVisibilityFlags
 Default visibility flags. More...
 

Friends

class BaseInstanceBatchVTF
 
class InstanceBatch
 
class InstanceBatchHW
 
class InstanceBatchHW_VTF
 
class InstanceBatchShader
 

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 79 of file OgreInstancedEntity.h.

Member Typedef Documentation

Definition at line 237 of file OgreAnimable.h.

SceneManager::cullFrustum

Remarks
We don't pass by reference on purpose (avoid implicit aliasing) We perform frustum culling AND test visibility mask at the same time
Parameters
frustumFrustum to clip against
sceneVisibilityFlagsCombined scene's visibility flags (i.e. viewport | scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters.
outCulledObjectsOut. List of objects that are (fully or partially) inside the frustum and should be rendered
lodCameraCamera in which lod levels calculations are based (i.e. during shadow pass renders) Note however, we only use this camera to calulate if should be visible according to mUpperDistance

Definition at line 244 of file OgreMovableObject.h.

Member Function Documentation

StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void  )
inlineprotectedinherited

Get an updateable reference to animable value list.

Definition at line 263 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

LightList* Ogre::MovableObject::_getLightList ( )
inlineinherited

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 534 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::_getManager ( void  ) const
inlineinherited

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

Definition at line 160 of file OgreMovableObject.h.

ObjectData& Ogre::MovableObject::_getObjectData ( )
inlineinherited

Returns a direct access to the ObjectData state.

Definition at line 387 of file OgreMovableObject.h.

const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform ( void  ) const
inherited

Returns the full transformation of the parent sceneNode or the attachingPoint node.

void Ogre::MovableObject::_notifyManager ( SceneManager man)
inlineinherited

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

Definition at line 158 of file OgreMovableObject.h.

void Ogre::MovableObject::_setCachedAabbOutOfDate ( void  )
inlineinherited

Definition at line 586 of file OgreMovableObject.h.

void Ogre::IdObject::_setId ( IdType  newId)
inlineprotectedinherited

In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private).

Definition at line 63 of file OgreId.h.

void Ogre::MovableObject::addQueryFlags ( uint32  flags)
inlineinherited

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

void Ogre::MovableObject::addVisibilityFlags ( uint32  flags)
inlineinherited

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

static void Ogre::MovableObject::buildLightList ( const size_t  numNodes,
ObjectData  t,
const LightListInfo globalLightList 
)
staticinherited

SceneManager::buildLightList

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
Parameters
globalLightListList of lights already culled against all possible frustums and reorganized contiguously for SoA
static void Ogre::MovableObject::calculateCastersBox ( const size_t  numNodes,
ObjectData  t,
uint32  sceneVisibilityFlags,
AxisAlignedBox outBox 
)
staticinherited
void Ogre::AnimableObject::createAnimableDictionary ( void  ) const
inlineprotectedinherited

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

Definition at line 250 of file OgreAnimable.h.

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String valueName)
inlinevirtualinherited

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 316 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

static void Ogre::MovableObject::cullFrustum ( const size_t  numNodes,
ObjectData  t,
const Frustum frustum,
uint32  sceneVisibilityFlags,
MovableObjectArray outCulledObjects,
const Camera lodCamera 
)
staticinherited
static void Ogre::MovableObject::cullLights ( const size_t  numNodes,
ObjectData  t,
LightListInfo outGlobalLightList,
const FrustumVec frustums,
const FrustumVec cubemapFrustums 
)
staticinherited

SceneManager::cullLights &

See also
MovableObject::cullFrustum Produces the global list of visible lights that is needed in buildLightList
Remarks
We don't pass ObjectData by reference on purpose (avoid implicit aliasing) It's declared here because all affected elements are from MovableObject IMPORTANT: It is assumed that all objects in ObjectData are Lights.
Parameters
outGlobalLightListOutput, a list of lights, contiguously placed
frustumsAn array of all frustums we need to check against
cubemapFrustumsAn array of all frustums that are used at least once as cubemaps ( SceneManager::createCamera)
void Ogre::MovableObject::detachFromParent ( void  )
inherited

Detaches an object from a parent SceneNode if attached.

virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void  ) const
inlineprotectedvirtualinherited

Get the name of the animable dictionary for this class.

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

Definition at line 245 of file OgreAnimable.h.

References Ogre::BLANKSTRING.

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void  ) const
inlineinherited

Gets a list of animable value names for this object.

Definition at line 291 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

bool Ogre::MovableObject::getCastShadows ( void  ) const
inlineinherited

Returns whether shadow casting is enabled for this object.

const FastArray<unsigned char>& Ogre::MovableObject::getCurrentMaterialLod ( void  ) const
inlineinherited

Definition at line 536 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )
inlinestaticinherited

Get the default query flags for all future MovableObject instances.

Definition at line 464 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( )
inlinestaticinherited

Get the default visibility flags for all future MovableObject instances.

Definition at line 495 of file OgreMovableObject.h.

IdType Ogre::IdObject::getId ( ) const
inlineinherited

Get the unique id of this object.

Definition at line 74 of file OgreId.h.

uint32 Ogre::MovableObject::getLightMask ( ) const
inlineinherited

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
Listener* Ogre::MovableObject::getListener ( void  ) const
inlineinherited

Gets the current listener for this object.

Definition at line 506 of file OgreMovableObject.h.

Aabb Ogre::MovableObject::getLocalAabb ( void  ) const
inherited

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

Remarks
This bounding box is in local coordinates.
const String& Ogre::MovableObject::getName ( void  ) const
inlineinherited

Returns the name of this object.

Definition at line 166 of file OgreMovableObject.h.

Node* Ogre::MovableObject::getParentNode ( void  ) const
inlineinherited

Returns the node to which this object is attached.

Definition at line 172 of file OgreMovableObject.h.

SceneNode* Ogre::MovableObject::getParentSceneNode ( void  ) const
inlineinherited
uint32 Ogre::MovableObject::getQueryFlags ( void  ) const
inlineinherited

Returns the query flags relevant for this object.

bool Ogre::MovableObject::getReceivesShadows ( )
inherited

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

Real Ogre::MovableObject::getRenderingDistance ( void  ) const
inlineinherited

Gets the distance at which batches are no longer rendered.

Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const
inlineinherited

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

Definition at line 338 of file OgreMovableObject.h.

uint8 Ogre::MovableObject::getRenderQueueGroup ( void  ) const
inherited

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

UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( )
inlineinherited

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 344 of file OgreMovableObject.h.

const UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) const
inlineinherited

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 350 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::getVisibilityFlags ( void  ) const
inlineinherited

Returns the visibility flags relevant for this object.

Reserved visibility flags are not returned.

bool Ogre::MovableObject::getVisible ( void  ) const
inlineinherited

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

Remarks
Returns the value set by MovableObject::setVisible only.
Aabb Ogre::MovableObject::getWorldAabb ( ) const
inherited

Gets the axis aligned box in world space.

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldAabbUpdated if you need the update process to be guaranteed
Aabb Ogre::MovableObject::getWorldAabbUpdated ( )
inherited

Gets the axis aligned box in world space.

Remarks
Unlike getWorldAabb, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
float Ogre::MovableObject::getWorldRadius ( ) const
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldRadiusUpdated if you need the update process to be guaranteed
float Ogre::MovableObject::getWorldRadiusUpdated ( )
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Unlike getWorldRadius, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector ) const
inlineprotectedvirtualinherited

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

Definition at line 283 of file OgreAnimable.h.

virtual void Ogre::MovableObject::instanceBatchCullFrustumThreaded ( const Frustum frustum,
const Camera lodCamera,
uint32  combinedVisibilityFlags 
)
inlinevirtualinherited

InstancingTheadedCullingMethod,

See also
InstanceBatch::instanceBatchCullFrustumThreaded

Reimplemented in Ogre::InstanceBatchHW_VTF, and Ogre::InstanceBatchHW.

Definition at line 250 of file OgreMovableObject.h.

bool Ogre::MovableObject::isAttached ( void  ) const
inlineinherited

Returns true if this object is attached to a Node.

Definition at line 181 of file OgreMovableObject.h.

bool Ogre::MovableObject::isCachedAabbOutOfDate ( ) const
inlineinherited

Definition at line 587 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::isDebugDisplayEnabled ( void  ) const
inlinevirtualinherited

Gets whether debug display of this object is enabled.

Definition at line 582 of file OgreMovableObject.h.

bool Ogre::MovableObject::isStatic ( ) const
inherited

Checks whether this MovableObject is static. setStatic.

bool Ogre::MovableObject::isVisible ( void  ) const
inherited

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

Remarks
Takes into account visibility flags and the setVisible, but not rendering distance.
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 76 of file OgreId.h.

References Ogre::IdObject::mId.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 81 of file OgreId.h.

References Ogre::IdObject::mId.

const LightList& Ogre::MovableObject::queryLights ( void  ) const
inlineinherited

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

Remarks
The lights are filled in
See also
buildLightList
Returns
The list of lights use to lighting this object.

Definition at line 513 of file OgreMovableObject.h.

void Ogre::MovableObject::removeQueryFlags ( uint32  flags)
inlineinherited

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

void Ogre::MovableObject::removeVisibilityFlags ( uint32  flags)
inlineinherited

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

void Ogre::MovableObject::setCastShadows ( bool  enabled)
inlineinherited

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.
virtual void Ogre::MovableObject::setDebugDisplayEnabled ( bool  enabled)
inlinevirtualinherited

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 580 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32  flags)
inlinestaticinherited

Set the default query flags for all future MovableObject instances.

Definition at line 460 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32  flags)
inlinestaticinherited

Set the default visibility flags for all future MovableObject instances.

void Ogre::MovableObject::setLightMask ( uint32  lightMask)
inlineinherited

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
void Ogre::MovableObject::setListener ( Listener listener)
inlineinherited

Sets a listener for this object.

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

Definition at line 502 of file OgreMovableObject.h.

void Ogre::MovableObject::setLocalAabb ( const Aabb  box)
inherited

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

Remarks
This bounding box is in local coordinates.
void Ogre::MovableObject::setName ( const String name)
inlineinherited

Sets a custom name for this node.

Doesn't have to be unique

Definition at line 163 of file OgreMovableObject.h.

void Ogre::MovableObject::setQueryFlags ( uint32  flags)
inlineinherited

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.
void Ogre::MovableObject::setRenderingDistance ( Real  dist)
inlineinherited

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

Parameters
distDistance beyond which the object will not be rendered (the default is FLT_MAX, which means objects are always rendered). Values equal or below zero will be ignored, and cause an assertion in debug mode.
void Ogre::MovableObject::setRenderingMinPixelSize ( Real  pixelSize)
inlineinherited

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
pixelSizeNumber of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 331 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderQueueGroup ( uint8  queueID)
virtualinherited

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
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

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

virtual void Ogre::MovableObject::setRenderQueueGroupAndPriority ( uint8  queueID,
ushort  priority 
)
virtualinherited

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
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
priorityThe priority within a group to use.

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

bool Ogre::MovableObject::setStatic ( bool  bStatic)
inherited

Turns this Node into static or dynamic.

Remarks
Switching between dynamic and static has some overhead and forces to update all static scene when converted to static. So don't do it frequently. Static objects are not updated every frame, only when requested explicitly. Use this feature if you plan to have this object unaltered for a very long times
Note all MovableObjects support switching between static & dynamic after they have been created (eg. InstancedEntity)
Changing this attribute will cause to switch the attribute to our parent node, and as a result, all of its other attached entities. Node::setStatic
Returns
True if setStatic made an actual change. False otherwise. Can fail because the object was already static/dynamic, or because switching is not supported
void Ogre::MovableObject::setVisibilityFlags ( uint32  flags)
inlineinherited

Sets the visibility flags for this object.

Remarks
As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags that is applied a binary 'and' with the SceneManager's mask and a compositor node pass. To exclude particular objects from rendering. Changes to reserved visibility flags are ignored (won't take effect).
void Ogre::MovableObject::setVisible ( bool  visible)
inlineinherited

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.
static void Ogre::MovableObject::updateAllBounds ( const size_t  numNodes,
ObjectData  t 
)
staticinherited

SceneManager::updateAllBounds

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
Aabb Ogre::MovableObject::updateSingleWorldAabb ( )
protectedinherited
float Ogre::MovableObject::updateSingleWorldRadius ( )
protectedinherited

Member Data Documentation

const FastArray<Real> Ogre::MovableObject::c_DefaultLodMesh
inherited

Definition at line 65 of file OgreMovableObject.h.

bool Ogre::MovableObject::mCachedAabbOutOfDate
mutableprotectedinherited

Definition at line 117 of file OgreMovableObject.h.

FastArray<unsigned char> Ogre::MovableObject::mCurrentMaterialLod
protectedinherited

Definition at line 97 of file OgreMovableObject.h.

unsigned char Ogre::MovableObject::mCurrentMeshLod
protectedinherited

Definition at line 96 of file OgreMovableObject.h.

bool Ogre::MovableObject::mDebugDisplay
protectedinherited

Is debug display enabled?

Definition at line 111 of file OgreMovableObject.h.

size_t Ogre::MovableObject::mGlobalIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 140 of file OgreMovableObject.h.

LightList Ogre::MovableObject::mLightList
protectedinherited

List of lights for this object.

Definition at line 108 of file OgreMovableObject.h.

Listener* Ogre::MovableObject::mListener
protectedinherited

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

Definition at line 105 of file OgreMovableObject.h.

FastArray< FastArray<Real> const * > Ogre::MovableObject::mLodMaterial
protectedinherited

Definition at line 95 of file OgreMovableObject.h.

FastArray<Real> const* Ogre::MovableObject::mLodMesh
protectedinherited

Definition at line 94 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::mManager
protectedinherited

SceneManager holding this object (if applicable)

Definition at line 91 of file OgreMovableObject.h.

Real Ogre::MovableObject::mMinPixelSize
protectedinherited

Minimum pixel size to still render.

Definition at line 100 of file OgreMovableObject.h.

String Ogre::MovableObject::mName
protectedinherited

Friendly name of this object, can be empty.

Definition at line 121 of file OgreMovableObject.h.

ObjectData Ogre::MovableObject::mObjectData
protectedinherited

All the object data needed in SoA form.

Definition at line 89 of file OgreMovableObject.h.

ObjectMemoryManager* Ogre::MovableObject::mObjectMemoryManager
protectedinherited

The memory manager used to allocate the ObjectData.

Definition at line 114 of file OgreMovableObject.h.

size_t Ogre::MovableObject::mParentIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 142 of file OgreMovableObject.h.

Node* Ogre::MovableObject::mParentNode
protectedinherited

Node to which this object is attached.

Definition at line 83 of file OgreMovableObject.h.

uint8 Ogre::MovableObject::mRenderQueueID
protectedinherited

The render queue to use when rendering this object.

Definition at line 85 of file OgreMovableObject.h.

ushort Ogre::MovableObject::mRenderQueuePriority
protectedinherited

The render queue group to use when rendering this object.

Definition at line 87 of file OgreMovableObject.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary
staticprotectedinherited

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

Definition at line 239 of file OgreAnimable.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags
staticprotectedinherited

Default query flags.

Definition at line 125 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags
staticprotectedinherited

Default visibility flags.

Definition at line 127 of file OgreMovableObject.h.

UserObjectBindings Ogre::MovableObject::mUserObjectBindings
protectedinherited

User objects binding.

Definition at line 102 of file OgreMovableObject.h.


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