#include <OgreMovablePlane.h>
Public Types | |||||||
enum | Side { NO_SIDE, POSITIVE_SIDE, NEGATIVE_SIDE, BOTH_SIDE } | ||||||
The "positive side" of the plane is the half space to which the plane normal points. More... | |||||||
typedef std::vector < ShadowRenderable * > | ShadowRenderableList | ||||||
typedef VectorIterator < ShadowRenderableList > | ShadowRenderableListIterator | ||||||
Public Member Functions | |||||||
MovablePlane (const String &name) | |||||||
MovablePlane (const Plane &rhs) | |||||||
MovablePlane (const Vector3 &rkNormal, Real fConstant) | |||||||
Construct a plane through a normal, and a distance to move the plane along the normal. | |||||||
MovablePlane (const Vector3 &rkNormal, const Vector3 &rkPoint) | |||||||
MovablePlane (const Vector3 &rkPoint0, const Vector3 &rkPoint1, const Vector3 &rkPoint2) | |||||||
~MovablePlane () | |||||||
void | _notifyCurrentCamera (Camera *) | ||||||
Overridden from MovableObject. | |||||||
const AxisAlignedBox & | getBoundingBox (void) const | ||||||
Overridden from MovableObject. | |||||||
Real | getBoundingRadius (void) const | ||||||
Overridden from MovableObject. | |||||||
void | _updateRenderQueue (RenderQueue *) | ||||||
Overridden from MovableObject. | |||||||
const String & | getMovableType (void) const | ||||||
Overridden from MovableObject. | |||||||
const Plane & | _getDerivedPlane (void) const | ||||||
Get the derived plane as transformed by its parent node. | |||||||
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.
| |||||||
Side | getSide (const Vector3 &rkPoint) const | ||||||
Side | getSide (const AxisAlignedBox &rkBox) const | ||||||
returns the side where the aligneBox is. | |||||||
Side | getSide (const Vector3 ¢re, const Vector3 &halfSize) const | ||||||
Returns which side of the plane that the given box lies on. | |||||||
Real | getDistance (const Vector3 &rkPoint) const | ||||||
This is a pseudodistance. | |||||||
void | redefine (const Vector3 &rkPoint0, const Vector3 &rkPoint1, const Vector3 &rkPoint2) | ||||||
Redefine this plane based on 3 points. | |||||||
void | redefine (const Vector3 &rkNormal, const Vector3 &rkPoint) | ||||||
Redefine this plane based on a normal and a point. | |||||||
Vector3 | projectVector (const Vector3 &v) const | ||||||
Project a vector onto the plane. | |||||||
Real | normalise (void) | ||||||
Normalises the plane. | |||||||
bool | operator== (const Plane &rhs) const | ||||||
Comparison operator. | |||||||
bool | operator!= (const Plane &rhs) 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 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 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. | |||||||
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. | |||||||
Public Attributes | |||||||
Vector3 | normal | ||||||
Real | d | ||||||
Protected Types | |||||||
typedef std::map< String, StringVector > | AnimableDictionaryMap | ||||||
Protected Member Functions | |||||||
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 | |||||||
Plane | mDerivedPlane | ||||||
Vector3 | mLastTranslate | ||||||
Quaternion | mLastRotate | ||||||
AxisAlignedBox | mNullBB | ||||||
bool | mDirty | ||||||
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. | |||||||
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. | |||||||
Static Protected Attributes | |||||||
static String | msMovableType | ||||||
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 | |||||||
_OgreExport friend std::ostream & | operator<< (std::ostream &o, const Plane &p) |
Definition at line 53 of file OgreMovablePlane.h.
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.
enum Ogre::Plane::Side [inherited] |
The "positive side" of the plane is the half space to which the plane normal points.
The "negative side" is the other half space. The flag "no side" indicates the plane itself.
Definition at line 72 of file OgrePlane.h.
Ogre::MovablePlane::MovablePlane | ( | const String & | name | ) |
Ogre::MovablePlane::MovablePlane | ( | const Plane & | rhs | ) |
Construct a plane through a normal, and a distance to move the plane along the normal.
Ogre::MovablePlane::MovablePlane | ( | const Vector3 & | rkPoint0, | |
const Vector3 & | rkPoint1, | |||
const Vector3 & | rkPoint2 | |||
) |
Ogre::MovablePlane::~MovablePlane | ( | ) |
Definition at line 71 of file OgreMovablePlane.h.
void Ogre::MovablePlane::_notifyCurrentCamera | ( | Camera * | ) | [virtual] |
Overridden from MovableObject.
Reimplemented from Ogre::MovableObject.
Definition at line 73 of file OgreMovablePlane.h.
const AxisAlignedBox& Ogre::MovablePlane::getBoundingBox | ( | void | ) | const [virtual] |
Overridden from MovableObject.
Implements Ogre::MovableObject.
Definition at line 75 of file OgreMovablePlane.h.
Real Ogre::MovablePlane::getBoundingRadius | ( | void | ) | const [virtual] |
Overridden from MovableObject.
Implements Ogre::MovableObject.
Definition at line 77 of file OgreMovablePlane.h.
References Ogre::Math::POS_INFINITY.
void Ogre::MovablePlane::_updateRenderQueue | ( | RenderQueue * | ) | [virtual] |
Overridden from MovableObject.
Implements Ogre::MovableObject.
Definition at line 79 of file OgreMovablePlane.h.
const String& Ogre::MovablePlane::getMovableType | ( | void | ) | const [virtual] |
const Plane& Ogre::MovablePlane::_getDerivedPlane | ( | void | ) | const |
Get the derived plane as transformed by its parent node.
void Ogre::MovablePlane::visitRenderables | ( | Renderable::Visitor * | visitor, | |
bool | debugRenderables = false | |||
) | [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.
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. |
Implements Ogre::MovableObject.
Definition at line 85 of file OgreMovablePlane.h.
Referenced by Ogre::PlaneBoundedVolume::intersects().
Side Ogre::Plane::getSide | ( | const AxisAlignedBox & | rkBox | ) | const [inherited] |
returns the side where the aligneBox is.
the flag BOTH_SIDE indicates an intersecting box. one corner ON the plane is sufficient to consider the box and the plane intersecting.
Returns which side of the plane that the given box lies on.
The box is defined as centre/half-size pairs for effectively.
centre | The centre of the box. | |
halfSize | The half-size of the box. |
This is a pseudodistance.
The sign of the return value is positive if the point is on the positive side of the plane, negative if the point is on the negative side, and zero if the point is on the plane.
Referenced by Ogre::PlaneBoundedVolume::intersects().
void Ogre::Plane::redefine | ( | const Vector3 & | rkPoint0, | |
const Vector3 & | rkPoint1, | |||
const Vector3 & | rkPoint2 | |||
) | [inherited] |
Redefine this plane based on 3 points.
Redefine this plane based on a normal and a point.
Project a vector onto the plane.
v | The input vector |
Real Ogre::Plane::normalise | ( | void | ) | [inherited] |
Normalises the plane.
bool Ogre::Plane::operator== | ( | const Plane & | rhs | ) | const [inherited] |
Comparison operator.
Definition at line 140 of file OgrePlane.h.
References Ogre::Plane::d, and Ogre::Plane::normal.
bool Ogre::Plane::operator!= | ( | const Plane & | rhs | ) | const [inherited] |
virtual void Ogre::MovableObject::_notifyCreator | ( | MovableObjectFactory * | fact | ) | [virtual, inherited] |
Notify the object of it's creator (internal use only).
Definition at line 169 of file OgreMovableObject.h.
virtual MovableObjectFactory* Ogre::MovableObject::_getCreator | ( | void | ) | const [virtual, inherited] |
Get the creator of this object, if any (internal use only).
Definition at line 171 of file OgreMovableObject.h.
virtual void Ogre::MovableObject::_notifyManager | ( | SceneManager * | man | ) | [virtual, inherited] |
Notify the object of it's manager (internal use only).
Definition at line 173 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 175 of file OgreMovableObject.h.
virtual const String& Ogre::MovableObject::getName | ( | void | ) | const [virtual, inherited] |
Returns the name of this object.
Reimplemented in Ogre::Camera.
Definition at line 178 of file OgreMovableObject.h.
virtual Node* Ogre::MovableObject::getParentNode | ( | void | ) | const [virtual, inherited] |
Returns the node to which this object is attached.
virtual SceneNode* Ogre::MovableObject::getParentSceneNode | ( | void | ) | const [virtual, inherited] |
Returns the scene node to which this object is attached.
virtual void Ogre::MovableObject::_notifyAttached | ( | Node * | parent, | |
bool | isTagPoint = false | |||
) | [virtual, inherited] |
Internal method called to notify the object that it has been attached to a node.
Reimplemented in Ogre::Entity, Ogre::Light, and Ogre::ParticleSystem.
virtual bool Ogre::MovableObject::isAttached | ( | void | ) | const [virtual, inherited] |
virtual void Ogre::MovableObject::detatchFromParent | ( | void | ) | [virtual, inherited] |
virtual bool Ogre::MovableObject::isInScene | ( | void | ) | const [virtual, inherited] |
virtual void Ogre::MovableObject::_notifyMoved | ( | void | ) | [virtual, inherited] |
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] |
virtual void Ogre::MovableObject::setVisible | ( | bool | visible | ) | [virtual, inherited] |
Tells this object whether to be visible or not, if it has a renderable component.
Reimplemented in Ogre::Light.
virtual bool Ogre::MovableObject::getVisible | ( | void | ) | const [virtual, inherited] |
Gets this object whether to be visible or not, if it has a renderable component.
virtual bool Ogre::MovableObject::isVisible | ( | void | ) | const [virtual, inherited] |
Returns whether or not this object is supposed to be visible or not.
Reimplemented in Ogre::InstancedGeometry::BatchInstance, and Ogre::StaticGeometry::Region.
virtual void Ogre::MovableObject::setRenderingDistance | ( | Real | dist | ) | [virtual, inherited] |
Sets the distance at which the object is no longer rendered.
dist | Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered). |
Definition at line 280 of file OgreMovableObject.h.
virtual Real Ogre::MovableObject::getRenderingDistance | ( | void | ) | const [virtual, inherited] |
Gets the distance at which batches are no longer rendered.
Definition at line 286 of file OgreMovableObject.h.
virtual void Ogre::MovableObject::setUserObject | ( | UserDefinedObject * | obj | ) | [virtual, inherited] |
Call this to associate your own custom user object instance with this MovableObject.
Definition at line 294 of file OgreMovableObject.h.
virtual UserDefinedObject* Ogre::MovableObject::getUserObject | ( | void | ) | [virtual, inherited] |
Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject.
Definition at line 298 of file OgreMovableObject.h.
References Ogre::any_cast().
virtual void Ogre::MovableObject::setUserAny | ( | const Any & | anything | ) | [virtual, inherited] |
Sets any kind of user value on this object.
Definition at line 310 of file OgreMovableObject.h.
virtual const Any& Ogre::MovableObject::getUserAny | ( | void | ) | const [virtual, inherited] |
Retrieves the custom user value associated with this object.
Definition at line 314 of file OgreMovableObject.h.
virtual void Ogre::MovableObject::setRenderQueueGroup | ( | uint8 | queueID | ) | [virtual, inherited] |
Sets the render queue group this entity will be rendered through.
queueID | Enumerated value of the queue group to use. |
Reimplemented in Ogre::Entity, and Ogre::ParticleSystem.
virtual uint8 Ogre::MovableObject::getRenderQueueGroup | ( | void | ) | const [virtual, inherited] |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
virtual const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform | ( | void | ) | const [virtual, inherited] |
return the full transformation of the parent sceneNode or the attachingPoint node
virtual void Ogre::MovableObject::setQueryFlags | ( | uint32 | flags | ) | [virtual, inherited] |
Sets the query flags for this object.
Definition at line 342 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 346 of file OgreMovableObject.h.
virtual void Ogre::MovableObject::removeQueryFlags | ( | unsigned long | flags | ) | [virtual, inherited] |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 350 of file OgreMovableObject.h.
virtual uint32 Ogre::MovableObject::getQueryFlags | ( | void | ) | const [virtual, inherited] |
Returns the query flags relevant for this object.
Definition at line 353 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 357 of file OgreMovableObject.h.
static uint32 Ogre::MovableObject::getDefaultQueryFlags | ( | ) | [static, inherited] |
Get the default query flags for all future MovableObject instances.
Definition at line 361 of file OgreMovableObject.h.
virtual void Ogre::MovableObject::setVisibilityFlags | ( | uint32 | flags | ) | [virtual, inherited] |
Sets the visiblity flags for this object.
Definition at line 370 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 374 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 378 of file OgreMovableObject.h.
virtual uint32 Ogre::MovableObject::getVisibilityFlags | ( | void | ) | const [virtual, inherited] |
Returns the visibility flags relevant for this object.
Definition at line 381 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 385 of file OgreMovableObject.h.
static uint32 Ogre::MovableObject::getDefaultVisibilityFlags | ( | ) | [static, inherited] |
Get the default visibility flags for all future MovableObject instances.
Definition at line 389 of file OgreMovableObject.h.
virtual void Ogre::MovableObject::setListener | ( | Listener * | listener | ) | [virtual, inherited] |
Sets a listener for this object.
Definition at line 396 of file OgreMovableObject.h.
virtual Listener* Ogre::MovableObject::getListener | ( | void | ) | const [virtual, inherited] |
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.
virtual LightList* Ogre::MovableObject::_getLightList | ( | ) | [virtual, inherited] |
Returns a pointer to the current list of lights for this object.
Definition at line 428 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 431 of file OgreMovableObject.h.
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 433 of file OgreMovableObject.h.
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.
const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds | ( | void | ) | const [virtual, inherited] |
const AxisAlignedBox& Ogre::MovableObject::getDarkCapBounds | ( | const Light & | light, | |
Real | dirLightExtrusionDist | |||
) | const [virtual, inherited] |
void Ogre::MovableObject::setCastShadows | ( | bool | enabled | ) | [inherited] |
Sets whether or not this object will cast shadows.
Definition at line 456 of file OgreMovableObject.h.
bool Ogre::MovableObject::getCastShadows | ( | void | ) | const [virtual, inherited] |
Returns whether shadow casting is enabled for this object.
Implements Ogre::ShadowCaster.
Definition at line 458 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 uint32 Ogre::MovableObject::getTypeFlags | ( | void | ) | const [virtual, inherited] |
Get the 'type flags' for this MovableObject.
Reimplemented in Ogre::BillboardSet, Ogre::Entity, Ogre::Frustum, Ogre::Light, Ogre::ParticleSystem, and Ogre::StaticGeometry::Region.
virtual void Ogre::MovableObject::setDebugDisplayEnabled | ( | bool | enabled | ) | [virtual, inherited] |
Sets whether or not the debug display of this object is enabled.
Definition at line 500 of file OgreMovableObject.h.
virtual bool Ogre::MovableObject::isDebugDisplayEnabled | ( | void | ) | const [virtual, inherited] |
Gets whether debug display of this object is enabled.
Definition at line 502 of file OgreMovableObject.h.
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.
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 |
Real Ogre::ShadowCaster::getExtrusionDistance | ( | const Vector3 & | objectPos, | |
const Light * | light | |||
) | const [protected, inherited] |
Helper method for calculating extrusion distance.
virtual void Ogre::ShadowCaster::updateEdgeListLightFacing | ( | EdgeData * | edgeData, | |
const Vector4 & | lightPos | |||
) | [protected, virtual, inherited] |
Tells the caster to perform the tasks necessary to update the edge data's light listing.
Can be overridden if the subclass needs to do additional things.
edgeData | The edge information to update | |
lightPos | 4D vector representing the light, a directional light has w=0.0 |
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.
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 void Ogre::ShadowCaster::extrudeBounds | ( | AxisAlignedBox & | box, | |
const Vector4 & | lightPos, | |||
Real | extrudeDist | |||
) | const [protected, virtual, inherited] |
Utility method for extruding a bounding box.
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 |
virtual const String& Ogre::AnimableObject::getAnimableDictionaryName | ( | void | ) | const [protected, virtual, inherited] |
Get the name of the animable dictionary for this class.
Reimplemented in Ogre::Light.
Definition at line 242 of file OgreAnimable.h.
References Ogre::StringUtil::BLANK.
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 247 of file OgreAnimable.h.
StringVector& Ogre::AnimableObject::_getAnimableValueNames | ( | void | ) | [protected, inherited] |
Get an updateable reference to animable value list.
Definition at line 260 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
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 280 of file OgreAnimable.h.
const StringVector& Ogre::AnimableObject::getAnimableValueNames | ( | void | ) | const [inherited] |
Gets a list of animable value names for this object.
Definition at line 288 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue | ( | const String & | valueName | ) | [virtual, inherited] |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light.
Definition at line 313 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 67 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, | |
void * | ptr | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, | |
const char * | file, | |||
int | line, | |||
const char * | func | |||
) | [inherited] |
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 84 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 89 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
void * | ||||
) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 106 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, | |
const char * | , | |||
int | , | |||
const char * | ||||
) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
_OgreExport friend std::ostream& operator<< | ( | std::ostream & | o, | |
const Plane & | p | |||
) | [friend, inherited] |
Plane Ogre::MovablePlane::mDerivedPlane [mutable, protected] |
Definition at line 56 of file OgreMovablePlane.h.
Vector3 Ogre::MovablePlane::mLastTranslate [mutable, protected] |
Definition at line 57 of file OgreMovablePlane.h.
Quaternion Ogre::MovablePlane::mLastRotate [mutable, protected] |
Definition at line 58 of file OgreMovablePlane.h.
AxisAlignedBox Ogre::MovablePlane::mNullBB [protected] |
Definition at line 59 of file OgreMovablePlane.h.
bool Ogre::MovablePlane::mDirty [mutable, protected] |
Definition at line 60 of file OgreMovablePlane.h.
String Ogre::MovablePlane::msMovableType [static, protected] |
Definition at line 61 of file OgreMovablePlane.h.
Vector3 Ogre::Plane::normal [inherited] |
Definition at line 136 of file OgrePlane.h.
Referenced by Ogre::Plane::operator!=(), Ogre::Matrix4::operator*(), and Ogre::Plane::operator==().
Real Ogre::Plane::d [inherited] |
Definition at line 137 of file OgrePlane.h.
Referenced by Ogre::Plane::operator!=(), Ogre::Matrix4::operator*(), and Ogre::Plane::operator==().
String Ogre::MovableObject::mName [protected, inherited] |
Name of this object.
Reimplemented in Ogre::Camera.
Definition at line 104 of file OgreMovableObject.h.
MovableObjectFactory* Ogre::MovableObject::mCreator [protected, inherited] |
Creator of this object (if created by a factory).
Definition at line 106 of file OgreMovableObject.h.
SceneManager* Ogre::MovableObject::mManager [protected, inherited] |
SceneManager holding this object (if applicable).
Definition at line 108 of file OgreMovableObject.h.
Node* Ogre::MovableObject::mParentNode [protected, inherited] |
bool Ogre::MovableObject::mParentIsTagPoint [protected, inherited] |
Definition at line 111 of file OgreMovableObject.h.
bool Ogre::MovableObject::mVisible [protected, inherited] |
bool Ogre::MovableObject::mDebugDisplay [protected, inherited] |
Real Ogre::MovableObject::mUpperDistance [protected, inherited] |
Real Ogre::MovableObject::mSquaredUpperDistance [protected, inherited] |
Definition at line 118 of file OgreMovableObject.h.
bool Ogre::MovableObject::mBeyondFarDistance [protected, inherited] |
Any Ogre::MovableObject::mUserAny [protected, inherited] |
User defined link to another object / value / whatever.
Definition at line 122 of file OgreMovableObject.h.
uint8 Ogre::MovableObject::mRenderQueueID [protected, inherited] |
The render queue to use when rendering this object.
Definition at line 124 of file OgreMovableObject.h.
bool Ogre::MovableObject::mRenderQueueIDSet [protected, inherited] |
Flags whether the RenderQueue's default should be used.
Definition at line 126 of file OgreMovableObject.h.
uint32 Ogre::MovableObject::mQueryFlags [protected, inherited] |
Flags determining whether this object is included / excluded from scene queries.
Definition at line 128 of file OgreMovableObject.h.
uint32 Ogre::MovableObject::mVisibilityFlags [protected, inherited] |
Flags determining whether this object is visible (compared to SceneManager mask).
Definition at line 130 of file OgreMovableObject.h.
AxisAlignedBox Ogre::MovableObject::mWorldAABB [mutable, protected, inherited] |
Cached world AABB of this object.
Reimplemented in Ogre::ParticleSystem.
Definition at line 132 of file OgreMovableObject.h.
Sphere Ogre::MovableObject::mWorldBoundingSphere [mutable, protected, inherited] |
Definition at line 134 of file OgreMovableObject.h.
AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds [mutable, protected, inherited] |
bool Ogre::MovableObject::mCastShadows [protected, inherited] |
bool Ogre::MovableObject::mRenderingDisabled [protected, inherited] |
Does rendering this object disabled by listener?
Definition at line 141 of file OgreMovableObject.h.
Listener* Ogre::MovableObject::mListener [protected, inherited] |
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 143 of file OgreMovableObject.h.
LightList Ogre::MovableObject::mLightList [mutable, protected, inherited] |
List of lights for this object.
Reimplemented in Ogre::StaticGeometry::Region.
Definition at line 146 of file OgreMovableObject.h.
ulong Ogre::MovableObject::mLightListUpdated [mutable, protected, inherited] |
The last frame that this light list was updated in.
Reimplemented in Ogre::StaticGeometry::Region.
Definition at line 148 of file OgreMovableObject.h.
uint32 Ogre::MovableObject::msDefaultQueryFlags [static, protected, inherited] |
uint32 Ogre::MovableObject::msDefaultVisibilityFlags [static, protected, inherited] |
AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary [static, protected, inherited] |
Static map of class name to list of animable value names.
Definition at line 236 of file OgreAnimable.h.
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:04:28 2009