#include <OgreManualObject.h>
Public Types | |
typedef std::vector < ManualObjectSection * > | SectionList |
typedef std::vector < ShadowRenderable * > | ShadowRenderableList |
typedef VectorIterator < ShadowRenderableList > | ShadowRenderableListIterator |
Public Member Functions | |
ManualObject (const String &name) | |
virtual | ~ManualObject () |
virtual void | clear (void) |
Completely clear the contents of the object. | |
virtual void | estimateVertexCount (size_t vcount) |
Estimate the number of vertices ahead of time. | |
virtual void | estimateIndexCount (size_t icount) |
Estimate the number of indices ahead of time. | |
virtual void | begin (const String &materialName, RenderOperation::OperationType opType=RenderOperation::OT_TRIANGLE_LIST) |
Start defining a part of the object. | |
virtual void | setDynamic (bool dyn) |
Use before defining gometry to indicate that you intend to update the geometry regularly and want the internal structure to reflect that. | |
virtual bool | getDynamic () const |
Gets whether this object is marked as dynamic. | |
virtual void | beginUpdate (size_t sectionIndex) |
Start the definition of an update to a part of the object. | |
virtual void | position (const Vector3 &pos) |
Add a vertex position, starting a new vertex at the same time. | |
virtual void | position (Real x, Real y, Real z) |
Add a vertex position, starting a new vertex at the same time.
| |
virtual void | normal (const Vector3 &norm) |
Add a vertex normal to the current vertex. | |
virtual void | normal (Real x, Real y, Real z) |
Add a vertex normal to the current vertex.
| |
virtual void | textureCoord (Real u) |
Add a texture coordinate to the current vertex. | |
virtual void | textureCoord (Real u, Real v) |
Add a texture coordinate to the current vertex.
| |
virtual void | textureCoord (Real u, Real v, Real w) |
Add a texture coordinate to the current vertex.
| |
virtual void | textureCoord (const Vector2 &uv) |
Add a texture coordinate to the current vertex.
| |
virtual void | textureCoord (const Vector3 &uvw) |
Add a texture coordinate to the current vertex.
| |
virtual void | colour (const ColourValue &col) |
Add a vertex colour to a vertex. | |
virtual void | colour (Real r, Real g, Real b, Real a=1.0f) |
Add a vertex colour to a vertex. | |
virtual void | index (uint16 idx) |
Add a vertex index to construct faces / lines / points via indexing rather than just by a simple list of vertices. | |
virtual void | triangle (uint16 i1, uint16 i2, uint16 i3) |
Add a set of 3 vertex indices to construct a triangle; this is a shortcut to calling index() 3 times. | |
virtual void | quad (uint16 i1, uint16 i2, uint16 i3, uint16 i4) |
Add a set of 4 vertex indices to construct a quad (out of 2 triangles); this is a shortcut to calling index() 6 times, or triangle() twice. | |
virtual ManualObjectSection * | end (void) |
Finish defining the object and compile the final renderable version. | |
virtual void | setMaterialName (size_t subindex, const String &name) |
Alter the material for a subsection of this object after it has been specified. | |
virtual MeshPtr | convertToMesh (const String &meshName, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) |
Convert this object to a Mesh. | |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. | |
void | setBoundingBox (const AxisAlignedBox &box) |
Sets the bounding box. | |
ManualObjectSection * | getSection (unsigned int index) const |
Gets a pointer to a ManualObjectSection, ie a part of a ManualObject. | |
unsigned int | getNumSections (void) const |
Retrieves the number of ManualObjectSection objects making up this ManualObject. | |
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. . | |
void | _updateRenderQueue (RenderQueue *queue) |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
| |
EdgeData * | getEdgeList (void) |
Implement this method to enable stencil shadows. | |
bool | hasEdgeList (void) |
Overridden member from ShadowCaster. | |
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDist, unsigned long flags=0) |
Implement this method to enable stencil shadows. | |
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 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 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 | 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. | |
const AxisAlignedBox & | getLightCapBounds (void) const |
Overridden member from ShadowCaster. | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const |
Overridden member from ShadowCaster. | |
void | setCastShadows (bool enabled) |
Sets whether or not this object will cast shadows. | |
bool | getCastShadows (void) const |
Returns whether shadow casting is enabled for this object. | |
Real | getPointExtrusionDistance (const Light *l) const |
Get the distance to extrude for a point/spot light. | |
virtual uint32 | getTypeFlags (void) const |
Get the 'type flags' for this MovableObject. | |
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. | |
Static Public Member Functions | |
static void | setDefaultQueryFlags (uint32 flags) |
Set the default query flags for all future MovableObject instances. | |
static uint32 | getDefaultQueryFlags () |
Get the default query flags for all future MovableObject instances. | |
static void | setDefaultVisibilityFlags (uint32 flags) |
Set the default visibility flags for all future MovableObject instances. | |
static uint32 | getDefaultVisibilityFlags () |
Get the default visibility flags for all future MovableObject instances. | |
static void | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist) |
Utility method for extruding vertices based on a light. | |
Protected Types | |
typedef std::map < String, StringVector > | AnimableDictionaryMap |
Protected Member Functions | |
virtual void | resetTempAreas (void) |
Delete temp buffers and reset init counts. | |
virtual void | resizeTempVertexBufferIfNeeded (size_t numVerts) |
Resize the temp vertex buffer? | |
virtual void | resizeTempIndexBufferIfNeeded (size_t numInds) |
Resize the temp index buffer? | |
virtual void | copyTempVertexToBuffer (void) |
Copy current temp vertex into buffer. | |
Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const |
Helper moethod 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 | |
bool | mDynamic |
Dynamic? | |
SectionList | mSectionList |
List of subsections. | |
ManualObjectSection * | mCurrentSection |
Current section. | |
bool | mCurrentUpdating |
Are we updating? | |
TempVertex | mTempVertex |
Temp storage. | |
bool | mFirstVertex |
First vertex indicator. | |
bool | mTempVertexPending |
Temp vertex data to copy? | |
char * | mTempVertexBuffer |
System-memory buffer whilst we establish the size required. | |
size_t | mTempVertexSize |
System memory allocation size, in bytes. | |
uint16 * | mTempIndexBuffer |
System-memory buffer whilst we establish the size required. | |
size_t | mTempIndexSize |
System memory allocation size, in bytes. | |
size_t | mDeclSize |
Current declaration vertex size. | |
size_t | mEstVertexCount |
Estimated vertex count. | |
size_t | mEstIndexCount |
Estimated index count. | |
ushort | mTexCoordIndex |
Current texture coordinate. | |
AxisAlignedBox | mAABB |
Bounding box. | |
Real | mRadius |
Bounding sphere. | |
bool | mAnyIndexed |
Any indexed geoemtry on any sections? | |
EdgeData * | mEdgeList |
Edge list, used if stencil shadow casting is enabled. | |
ShadowRenderableList | mShadowRenderables |
List of shadow renderables. | |
bool | mUseIdentityProjection |
Whether to use identity projection for sections. | |
bool | mUseIdentityView |
Whether to use identity view for sections. | |
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? | |
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 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. | |
Classes | |
class | ManualObjectSection |
Built, renderable section of geometry. More... | |
class | ManualObjectSectionShadowRenderable |
Nested class to allow shadows. More... | |
struct | TempVertex |
Temporary vertex structure. More... |
Definition at line 101 of file OgreManualObject.h.
typedef std::vector<ManualObjectSection*> Ogre::ManualObject::SectionList |
Definition at line 424 of file OgreManualObject.h.
typedef std::vector<ShadowRenderable*> Ogre::ShadowCaster::ShadowRenderableList [inherited] |
Definition at line 127 of file OgreShadowCaster.h.
typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator [inherited] |
Definition at line 128 of file OgreShadowCaster.h.
typedef std::map<String, StringVector> Ogre::AnimableObject::AnimableDictionaryMap [protected, inherited] |
Definition at line 206 of file OgreAnimable.h.
Ogre::ManualObject::ManualObject | ( | const String & | name | ) |
virtual Ogre::ManualObject::~ManualObject | ( | ) | [virtual] |
virtual void Ogre::ManualObject::clear | ( | void | ) | [virtual] |
Completely clear the contents of the object.
virtual void Ogre::ManualObject::estimateVertexCount | ( | size_t | vcount | ) | [virtual] |
Estimate the number of vertices ahead of time.
virtual void Ogre::ManualObject::estimateIndexCount | ( | size_t | icount | ) | [virtual] |
Estimate the number of indices ahead of time.
virtual void Ogre::ManualObject::begin | ( | const String & | materialName, | |
RenderOperation::OperationType | opType = RenderOperation::OT_TRIANGLE_LIST | |||
) | [virtual] |
Start defining a part of the object.
materialName | The name of the material to render this part of the object with. | |
opType | The type of operation to use to render. |
virtual void Ogre::ManualObject::setDynamic | ( | bool | dyn | ) | [virtual] |
Use before defining gometry to indicate that you intend to update the geometry regularly and want the internal structure to reflect that.
Definition at line 154 of file OgreManualObject.h.
virtual bool Ogre::ManualObject::getDynamic | ( | ) | const [virtual] |
virtual void Ogre::ManualObject::beginUpdate | ( | size_t | sectionIndex | ) | [virtual] |
Start the definition of an update to a part of the object.
sectionIndex | The index of the section you want to update. The first call to begin() would have created section 0, the second section 1, etc. |
virtual void Ogre::ManualObject::position | ( | const Vector3 & | pos | ) | [virtual] |
Add a vertex position, starting a new vertex at the same time.
Add a vertex position, starting a new vertex at the same time.
virtual void Ogre::ManualObject::normal | ( | const Vector3 & | norm | ) | [virtual] |
Add a vertex normal to the current vertex.
Add a vertex normal to the current vertex.
virtual void Ogre::ManualObject::textureCoord | ( | Real | u | ) | [virtual] |
Add a texture coordinate to the current vertex.
Add a texture coordinate to the current vertex.
Add a texture coordinate to the current vertex.
virtual void Ogre::ManualObject::textureCoord | ( | const Vector2 & | uv | ) | [virtual] |
Add a texture coordinate to the current vertex.
virtual void Ogre::ManualObject::textureCoord | ( | const Vector3 & | uvw | ) | [virtual] |
Add a texture coordinate to the current vertex.
virtual void Ogre::ManualObject::colour | ( | const ColourValue & | col | ) | [virtual] |
Add a vertex colour to a vertex.
Add a vertex colour to a vertex.
r,g,b,a | Colour components expressed as floating point numbers from 0-1 |
virtual void Ogre::ManualObject::index | ( | uint16 | idx | ) | [virtual] |
Add a vertex index to construct faces / lines / points via indexing rather than just by a simple list of vertices.
idx | A vertex index from 0 to 65535. |
Add a set of 3 vertex indices to construct a triangle; this is a shortcut to calling index() 3 times.
It is only valid for triangle lists.
i1,i2,i3 | 3 vertex indices from 0 to 65535 defining a face. |
Add a set of 4 vertex indices to construct a quad (out of 2 triangles); this is a shortcut to calling index() 6 times, or triangle() twice.
It's only valid for triangle list operations.
i1,i2,i3 | 3 vertex indices from 0 to 65535 defining a face. |
virtual ManualObjectSection* Ogre::ManualObject::end | ( | void | ) | [virtual] |
Finish defining the object and compile the final renderable version.
virtual void Ogre::ManualObject::setMaterialName | ( | size_t | subindex, | |
const String & | name | |||
) | [virtual] |
Alter the material for a subsection of this object after it has been specified.
subIndex | The index of the subsection to alter | |
name | The name of the new material to use |
virtual MeshPtr Ogre::ManualObject::convertToMesh | ( | const String & | meshName, | |
const String & | groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME | |||
) | [virtual] |
Convert this object to a Mesh.
meshName | The name to give the mesh | |
groupName | The resource group to create the mesh in |
void Ogre::ManualObject::setUseIdentityProjection | ( | bool | useIdentityProjection | ) |
Sets whether or not to use an 'identity' projection.
bool Ogre::ManualObject::getUseIdentityProjection | ( | void | ) | const |
Returns whether or not to use an 'identity' projection.
Definition at line 298 of file OgreManualObject.h.
void Ogre::ManualObject::setUseIdentityView | ( | bool | useIdentityView | ) |
Sets whether or not to use an 'identity' view.
bool Ogre::ManualObject::getUseIdentityView | ( | void | ) | const |
Returns whether or not to use an 'identity' view.
Definition at line 320 of file OgreManualObject.h.
void Ogre::ManualObject::setBoundingBox | ( | const AxisAlignedBox & | box | ) |
Sets the bounding box.
Definition at line 329 of file OgreManualObject.h.
ManualObjectSection* Ogre::ManualObject::getSection | ( | unsigned int | index | ) | const |
Gets a pointer to a ManualObjectSection, ie a part of a ManualObject.
unsigned int Ogre::ManualObject::getNumSections | ( | void | ) | const |
Retrieves the number of ManualObjectSection objects making up this ManualObject.
const String& Ogre::ManualObject::getMovableType | ( | void | ) | const [virtual] |
const AxisAlignedBox& Ogre::ManualObject::getBoundingBox | ( | void | ) | const [virtual] |
Retrieves the local axis-aligned bounding box for this object.
Implements Ogre::MovableObject.
Real Ogre::ManualObject::getBoundingRadius | ( | void | ) | const [virtual] |
Retrieves the radius of the origin-centered bounding sphere for this object. .
Implements Ogre::MovableObject.
void Ogre::ManualObject::_updateRenderQueue | ( | RenderQueue * | queue | ) | [virtual] |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
Implements Ogre::MovableObject.
EdgeData* Ogre::ManualObject::getEdgeList | ( | void | ) | [virtual] |
bool Ogre::ManualObject::hasEdgeList | ( | void | ) | [virtual] |
ShadowRenderableListIterator Ogre::ManualObject::getShadowVolumeRenderableIterator | ( | ShadowTechnique | shadowTechnique, | |
const Light * | light, | |||
HardwareIndexBufferSharedPtr * | indexBuffer, | |||
bool | extrudeVertices, | |||
Real | extrusionDist, | |||
unsigned long | flags = 0 | |||
) | [virtual] |
virtual void Ogre::ManualObject::resetTempAreas | ( | void | ) | [protected, virtual] |
Delete temp buffers and reset init counts.
virtual void Ogre::ManualObject::resizeTempVertexBufferIfNeeded | ( | size_t | numVerts | ) | [protected, virtual] |
Resize the temp vertex buffer?
virtual void Ogre::ManualObject::resizeTempIndexBufferIfNeeded | ( | size_t | numInds | ) | [protected, virtual] |
Resize the temp index buffer?
virtual void Ogre::ManualObject::copyTempVertexToBuffer | ( | void | ) | [protected, virtual] |
Copy current temp vertex into buffer.
virtual void Ogre::MovableObject::_notifyCreator | ( | MovableObjectFactory * | fact | ) | [virtual, inherited] |
Notify the object of it's creator (internal use only).
Definition at line 164 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 166 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 168 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 170 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 173 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 bool Ogre::MovableObject::isInScene | ( | void | ) | const [virtual, inherited] |
virtual void Ogre::MovableObject::_notifyMoved | ( | void | ) | [virtual, inherited] |
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.
Reimplemented in Ogre::BillboardChain, Ogre::BillboardSet, Ogre::Entity, Ogre::Frustum, Ogre::InstancedGeometry::BatchInstance, Ogre::MovablePlane, Ogre::ParticleSystem, Ogre::SimpleRenderable, and Ogre::StaticGeometry::Region.
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 272 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 278 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 286 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 290 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 302 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 306 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 334 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 338 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 342 of file OgreMovableObject.h.
virtual uint32 Ogre::MovableObject::getQueryFlags | ( | void | ) | const [virtual, inherited] |
Returns the query flags relevant for this object.
Definition at line 345 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 349 of file OgreMovableObject.h.
static uint32 Ogre::MovableObject::getDefaultQueryFlags | ( | ) | [static, inherited] |
Get the default query flags for all future MovableObject instances.
Definition at line 353 of file OgreMovableObject.h.
virtual void Ogre::MovableObject::setVisibilityFlags | ( | uint32 | flags | ) | [virtual, inherited] |
Sets the visiblity flags for this object.
Definition at line 362 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 366 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 370 of file OgreMovableObject.h.
virtual uint32 Ogre::MovableObject::getVisibilityFlags | ( | void | ) | const [virtual, inherited] |
Returns the visibility flags relevant for this object.
Definition at line 373 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 377 of file OgreMovableObject.h.
static uint32 Ogre::MovableObject::getDefaultVisibilityFlags | ( | ) | [static, inherited] |
Get the default visibility flags for all future MovableObject instances.
Definition at line 381 of file OgreMovableObject.h.
virtual void Ogre::MovableObject::setListener | ( | Listener * | listener | ) | [virtual, inherited] |
Sets a listener for this object.
Definition at line 388 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.
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 440 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 442 of file OgreMovableObject.h.
virtual uint32 Ogre::MovableObject::getTypeFlags | ( | void | ) | const [virtual, inherited] |
Get the 'type flags' for this MovableObject.
Reimplemented in Ogre::BillboardSet, Ogre::Entity, Ogre::Light, Ogre::ParticleSystem, and Ogre::StaticGeometry::Region.
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, ie 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 moethod 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 214 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 219 of file OgreAnimable.h.
StringVector& Ogre::AnimableObject::_getAnimableValueNames | ( | void | ) | [protected, inherited] |
Get an updateable reference to animable value list.
Definition at line 232 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 252 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 260 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 285 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
bool Ogre::ManualObject::mDynamic [protected] |
SectionList Ogre::ManualObject::mSectionList [protected] |
ManualObjectSection* Ogre::ManualObject::mCurrentSection [protected] |
bool Ogre::ManualObject::mCurrentUpdating [protected] |
TempVertex Ogre::ManualObject::mTempVertex [protected] |
bool Ogre::ManualObject::mFirstVertex [protected] |
bool Ogre::ManualObject::mTempVertexPending [protected] |
char* Ogre::ManualObject::mTempVertexBuffer [protected] |
System-memory buffer whilst we establish the size required.
Definition at line 451 of file OgreManualObject.h.
size_t Ogre::ManualObject::mTempVertexSize [protected] |
uint16* Ogre::ManualObject::mTempIndexBuffer [protected] |
System-memory buffer whilst we establish the size required.
Definition at line 455 of file OgreManualObject.h.
size_t Ogre::ManualObject::mTempIndexSize [protected] |
size_t Ogre::ManualObject::mDeclSize [protected] |
size_t Ogre::ManualObject::mEstVertexCount [protected] |
size_t Ogre::ManualObject::mEstIndexCount [protected] |
ushort Ogre::ManualObject::mTexCoordIndex [protected] |
AxisAlignedBox Ogre::ManualObject::mAABB [protected] |
Real Ogre::ManualObject::mRadius [protected] |
bool Ogre::ManualObject::mAnyIndexed [protected] |
EdgeData* Ogre::ManualObject::mEdgeList [protected] |
Edge list, used if stencil shadow casting is enabled.
Definition at line 473 of file OgreManualObject.h.
bool Ogre::ManualObject::mUseIdentityProjection [protected] |
bool Ogre::ManualObject::mUseIdentityView [protected] |
String Ogre::MovableObject::mName [protected, inherited] |
Name of this object.
Reimplemented in Ogre::Camera.
Definition at line 101 of file OgreMovableObject.h.
MovableObjectFactory* Ogre::MovableObject::mCreator [protected, inherited] |
Creator of this object (if created by a factory).
Definition at line 103 of file OgreMovableObject.h.
SceneManager* Ogre::MovableObject::mManager [protected, inherited] |
SceneManager holding this object (if applicable).
Definition at line 105 of file OgreMovableObject.h.
Node* Ogre::MovableObject::mParentNode [protected, inherited] |
bool Ogre::MovableObject::mParentIsTagPoint [protected, inherited] |
Definition at line 108 of file OgreMovableObject.h.
bool Ogre::MovableObject::mVisible [protected, inherited] |
Real Ogre::MovableObject::mUpperDistance [protected, inherited] |
Real Ogre::MovableObject::mSquaredUpperDistance [protected, inherited] |
Definition at line 113 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 117 of file OgreMovableObject.h.
uint8 Ogre::MovableObject::mRenderQueueID [protected, inherited] |
The render queue to use when rendering this object.
Definition at line 119 of file OgreMovableObject.h.
bool Ogre::MovableObject::mRenderQueueIDSet [protected, inherited] |
Flags whether the RenderQueue's default should be used.
Definition at line 121 of file OgreMovableObject.h.
uint32 Ogre::MovableObject::mQueryFlags [protected, inherited] |
Flags determining whether this object is included / excluded from scene queries.
Definition at line 123 of file OgreMovableObject.h.
uint32 Ogre::MovableObject::mVisibilityFlags [protected, inherited] |
Flags determining whether this object is visible (compared to SceneManager mask).
Definition at line 125 of file OgreMovableObject.h.
AxisAlignedBox Ogre::MovableObject::mWorldAABB [mutable, protected, inherited] |
Cached world AABB of this object.
Reimplemented in Ogre::ParticleSystem.
Definition at line 127 of file OgreMovableObject.h.
Sphere Ogre::MovableObject::mWorldBoundingSphere [mutable, protected, inherited] |
Definition at line 129 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 136 of file OgreMovableObject.h.
Listener* Ogre::MovableObject::mListener [protected, inherited] |
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 138 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 141 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 143 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 208 of file OgreAnimable.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat May 10 16:26:29 2008