Class providing a much simplified interface to generating manual objects with custom geometry. More...
#include <OgreManualObject.h>
Classes | |
class | ManualObjectSection |
Built, renderable section of geometry. More... | |
class | ManualObjectSectionShadowRenderable |
Nested class to allow shadows. More... | |
struct | TempVertex |
Temporary vertex structure. More... | |
Public Types | |
typedef vector < ManualObjectSection * > ::type | SectionList |
typedef vector < ShadowRenderable * >::type | ShadowRenderableList |
typedef VectorIterator < ShadowRenderableList > | ShadowRenderableListIterator |
Public Member Functions | |
ManualObject (const String &name) | |
virtual | ~ManualObject () |
virtual MovableObjectFactory * | _getCreator (void) const |
Get the creator of this object, if any (internal use only) More... | |
virtual LightList * | _getLightList () |
Returns a pointer to the current list of lights for this object. More... | |
virtual SceneManager * | _getManager (void) const |
Get the manager of this object, if any (internal use only) More... | |
virtual const Matrix4 & | _getParentNodeFullTransform (void) const |
return the full transformation of the parent sceneNode or the attachingPoint node More... | |
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false) |
Internal method called to notify the object that it has been attached to a node. More... | |
virtual void | _notifyCreator (MovableObjectFactory *fact) |
Notify the object of it's creator (internal use only) More... | |
virtual void | _notifyCurrentCamera (Camera *cam) |
Internal method to notify the object of the camera to be used for the next rendering operation. More... | |
virtual void | _notifyManager (SceneManager *man) |
Notify the object of it's manager (internal use only) More... | |
virtual void | _notifyMoved (void) |
Internal method called to notify the object that it has been moved. More... | |
void | _updateRenderQueue (RenderQueue *queue) |
virtual void | addQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
virtual void | addVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
virtual void | begin (const String &materialName, RenderOperation::OperationType opType=RenderOperation::OT_TRIANGLE_LIST, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) |
Start defining a part of the object. More... | |
virtual void | beginUpdate (size_t sectionIndex) |
Start the definition of an update to a part of the object. More... | |
virtual void | clear (void) |
Completely clear the contents of the object. More... | |
virtual void | colour (const ColourValue &col) |
Add a vertex colour to a vertex. More... | |
virtual void | colour (Real r, Real g, Real b, Real a=1.0f) |
Add a vertex colour to a vertex. More... | |
virtual MeshPtr | convertToMesh (const String &meshName, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) |
Convert this object to a Mesh. More... | |
virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
Create a reference-counted AnimableValuePtr for the named value. More... | |
virtual void | detachFromParent (void) |
Detaches an object from a parent SceneNode or TagPoint, if attached. More... | |
virtual ManualObjectSection * | end (void) |
Finish defining the object and compile the final renderable version. More... | |
virtual void | estimateIndexCount (size_t icount) |
Estimate the number of indices ahead of time. More... | |
virtual void | estimateVertexCount (size_t vcount) |
Estimate the number of vertices ahead of time. More... | |
const StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. More... | |
const AxisAlignedBox & | getBoundingBox (void) const |
Real | getBoundingRadius (void) const |
bool | getCastShadows (void) const |
Returns whether shadow casting is enabled for this object. More... | |
virtual size_t | getCurrentIndexCount () const |
Get the number of indices in the section currently being defined (returns 0 if no section is in progress). More... | |
virtual size_t | getCurrentVertexCount () const |
Get the number of vertices in the section currently being defined (returns 0 if no section is in progress). More... | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const |
Overridden member from ShadowCaster. More... | |
virtual bool | getDynamic () const |
Gets whether this object is marked as dynamic. More... | |
EdgeData * | getEdgeList (void) |
Implement this method to enable stencil shadows. More... | |
bool | getKeepDeclarationOrder () const |
Gets whether or not the declaration order is to be kept or not. More... | |
const AxisAlignedBox & | getLightCapBounds (void) const |
Overridden member from ShadowCaster. More... | |
virtual uint32 | getLightMask () const |
Get a bitwise mask which will filter the lights affecting this object. More... | |
virtual Listener * | getListener (void) const |
Gets the current listener for this object. More... | |
const String & | getMovableType (void) const |
virtual const String & | getName (void) const |
Returns the name of this object. More... | |
unsigned int | getNumSections (void) const |
Retrieves the number of ManualObjectSection objects making up this ManualObject. More... | |
virtual Node * | getParentNode (void) const |
Returns the node to which this object is attached. More... | |
virtual SceneNode * | getParentSceneNode (void) const |
Returns the scene node to which this object is attached. More... | |
Real | getPointExtrusionDistance (const Light *l) const |
Get the distance to extrude for a point/spot light. More... | |
virtual 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... | |
virtual Real | getRenderingDistance (void) const |
Gets the distance at which batches are no longer rendered. More... | |
virtual Real | getRenderingMinPixelSize () const |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More... | |
virtual uint8 | getRenderQueueGroup (void) const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. More... | |
ManualObjectSection * | getSection (unsigned int index) const |
Gets a pointer to a ManualObjectSection, i.e. More... | |
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0) |
Implement this method to enable stencil shadows. More... | |
virtual uint32 | getTypeFlags (void) const |
Get the 'type flags' for this MovableObject. More... | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. More... | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. More... | |
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
virtual uint32 | getVisibilityFlags (void) const |
Returns the visibility flags relevant for this object. More... | |
virtual bool | getVisible (void) const |
Gets this object whether to be visible or not, if it has a renderable component. More... | |
virtual const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const |
Retrieves the axis-aligned bounding box for this object in world coordinates. More... | |
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const |
Retrieves the worldspace bounding sphere for this object. More... | |
bool | hasEdgeList (void) |
Overridden member from ShadowCaster. More... | |
virtual void | index (uint32 idx) |
Add a vertex index to construct faces / lines / points via indexing rather than just by a simple list of vertices. More... | |
virtual bool | isAttached (void) const |
Returns true if this object is attached to a SceneNode or TagPoint. More... | |
virtual bool | isDebugDisplayEnabled (void) const |
Gets whether debug display of this object is enabled. More... | |
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. More... | |
virtual bool | isParentTagPoint () const |
Gets whether the parent node is a TagPoint (or a SceneNode) More... | |
virtual bool | isVisible (void) const |
Returns whether or not this object is supposed to be visible or not. More... | |
virtual void | normal (const Vector3 &norm) |
Add a vertex normal to the current vertex. More... | |
virtual void | normal (Real x, Real y, Real z) |
Add a vertex normal to the current vertex. 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) |
virtual void | position (const Vector3 &pos) |
Add a vertex position, starting a new vertex at the same time. More... | |
virtual void | position (Real x, Real y, Real z) |
Add a vertex position, starting a new vertex at the same time. More... | |
virtual void | quad (uint32 i1, uint32 i2, uint32 i3, uint32 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. More... | |
virtual const LightList & | queryLights (void) const |
Gets a list of lights, ordered relative to how close they are to this movable object. More... | |
virtual void | removeQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
virtual void | removeVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
void | setBoundingBox (const AxisAlignedBox &box) |
Sets the bounding box. More... | |
void | setCastShadows (bool enabled) |
Sets whether or not this object will cast shadows. More... | |
virtual void | setDebugDisplayEnabled (bool enabled) |
Sets whether or not the debug display of this object is enabled. More... | |
virtual void | setDynamic (bool dyn) |
Use before defining geometry to indicate that you intend to update the geometry regularly and want the internal structure to reflect that. More... | |
void | setKeepDeclarationOrder (bool keepOrder) |
Sets whether or not to keep the original declaration order when queuing the renderables. More... | |
virtual void | setLightMask (uint32 lightMask) |
Set a bitwise mask which will filter the lights affecting this object. More... | |
virtual void | setListener (Listener *listener) |
Sets a listener for this object. More... | |
virtual void | setMaterialName (size_t subIndex, const String &name, const String &group=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) |
Alter the material for a subsection of this object after it has been specified. More... | |
virtual void | setQueryFlags (uint32 flags) |
Sets the query flags for this object. More... | |
virtual void | setRenderingDistance (Real dist) |
Sets the distance at which the object is no longer rendered. More... | |
virtual 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... | |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. More... | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. More... | |
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything) |
virtual void | setVisibilityFlags (uint32 flags) |
Sets the visibility flags for this object. More... | |
virtual void | setVisible (bool visible) |
Tells this object whether to be visible or not, if it has a renderable component. More... | |
virtual void | tangent (const Vector3 &tan) |
Add a vertex tangent to the current vertex. More... | |
virtual void | tangent (Real x, Real y, Real z) |
Add a vertex tangent to the current vertex. More... | |
virtual void | textureCoord (Real u) |
Add a texture coordinate to the current vertex. More... | |
virtual void | textureCoord (Real u, Real v) |
Add a texture coordinate to the current vertex. More... | |
virtual void | textureCoord (Real u, Real v, Real w) |
Add a texture coordinate to the current vertex. More... | |
virtual void | textureCoord (Real x, Real y, Real z, Real w) |
Add a texture coordinate to the current vertex. More... | |
virtual void | textureCoord (const Vector2 &uv) |
Add a texture coordinate to the current vertex. More... | |
virtual void | textureCoord (const Vector3 &uvw) |
Add a texture coordinate to the current vertex. More... | |
virtual void | textureCoord (const Vector4 &xyzw) |
Add a texture coordinate to the current vertex. More... | |
virtual void | triangle (uint32 i1, uint32 i2, uint32 i3) |
Add a set of 3 vertex indices to construct a triangle; this is a shortcut to calling index() 3 times. More... | |
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 | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist) |
Utility method for extruding vertices based on a light. 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... | |
Protected Types | |
typedef map< String, StringVector >::type | AnimableDictionaryMap |
Protected Member Functions | |
StringVector & | _getAnimableValueNames (void) |
Get an updateable reference to animable value list. More... | |
virtual void | copyTempVertexToBuffer (void) |
Copy current temp vertex into buffer. 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... | |
virtual void | extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const |
Utility method for extruding a bounding box. More... | |
virtual void | generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, size_t &indexBufferUsedSize, 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. More... | |
virtual const String & | getAnimableDictionaryName (void) const |
Get the name of the animable dictionary for this class. More... | |
Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const |
Helper method for calculating extrusion distance. More... | |
virtual void | initialiseAnimableDictionary (StringVector &) const |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More... | |
virtual void | resetTempAreas (void) |
Delete temp buffers and reset init counts. More... | |
virtual void | resizeTempIndexBufferIfNeeded (size_t numInds) |
Resize the temp index buffer? More... | |
virtual void | resizeTempVertexBufferIfNeeded (size_t numVerts) |
Resize the temp vertex buffer? More... | |
virtual void | updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos) |
Tells the caster to perform the tasks necessary to update the edge data's light listing. More... | |
Protected Attributes | |
AxisAlignedBox | mAABB |
Bounding box. More... | |
bool | mAnyIndexed |
Any indexed geometry on any sections? More... | |
bool | mBeyondFarDistance |
Hidden because of distance? More... | |
bool | mCastShadows |
Does this object cast shadows? More... | |
MovableObjectFactory * | mCreator |
Creator of this object (if created by a factory) More... | |
ManualObjectSection * | mCurrentSection |
Current section. More... | |
bool | mCurrentUpdating |
Are we updating? More... | |
bool | mDebugDisplay |
Is debug display enabled? More... | |
size_t | mDeclSize |
Current declaration vertex size. More... | |
bool | mDynamic |
Dynamic? More... | |
EdgeData * | mEdgeList |
Edge list, used if stencil shadow casting is enabled. More... | |
size_t | mEstIndexCount |
Estimated index count. More... | |
size_t | mEstVertexCount |
Estimated vertex count. More... | |
bool | mFirstVertex |
First vertex indicator. More... | |
bool | mKeepDeclarationOrder |
Keep declaration order or let the queue optimize it. More... | |
LightList | mLightList |
List of lights for this object. More... | |
ulong | mLightListUpdated |
The last frame that this light list was updated in. More... | |
uint32 | mLightMask |
the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable More... | |
Listener * | mListener |
MovableObject listener - only one allowed (no list) for size & performance reasons. */. More... | |
SceneManager * | mManager |
SceneManager holding this object (if applicable) More... | |
Real | mMinPixelSize |
String | mName |
Name of this object. More... | |
bool | mParentIsTagPoint |
Node * | mParentNode |
node to which this object is attached More... | |
uint32 | mQueryFlags |
Flags determining whether this object is included / excluded from scene queries. More... | |
Real | mRadius |
Bounding sphere. More... | |
bool | mRenderingDisabled |
Does rendering this object disabled by listener? More... | |
uint8 | mRenderQueueID |
The render queue to use when rendering this object. More... | |
bool | mRenderQueueIDSet |
Flags whether the RenderQueue's default should be used. More... | |
ushort | mRenderQueuePriority |
The render queue group to use when rendering this object. More... | |
bool | mRenderQueuePrioritySet |
Flags whether the RenderQueue's default should be used. More... | |
SectionList | mSectionList |
List of subsections. More... | |
ShadowRenderableList | mShadowRenderables |
List of shadow renderables. More... | |
Real | mSquaredUpperDistance |
uint32 * | mTempIndexBuffer |
System-memory buffer whilst we establish the size required. More... | |
size_t | mTempIndexSize |
System memory allocation size, in bytes. More... | |
TempVertex | mTempVertex |
Temp storage. More... | |
char * | mTempVertexBuffer |
System-memory buffer whilst we establish the size required. More... | |
bool | mTempVertexPending |
Temp vertex data to copy? More... | |
size_t | mTempVertexSize |
System memory allocation size, in bytes. More... | |
ushort | mTexCoordIndex |
Current texture coordinate. More... | |
Real | mUpperDistance |
Upper distance to still render. More... | |
bool | mUseIdentityProjection |
Whether to use identity projection for sections. More... | |
bool | mUseIdentityView |
Whether to use identity view for sections. More... | |
UserObjectBindings | mUserObjectBindings |
User objects binding. More... | |
uint32 | mVisibilityFlags |
Flags determining whether this object is visible (compared to SceneManager mask) More... | |
bool | mVisible |
Is this object visible? More... | |
AxisAlignedBox | mWorldAABB |
Cached world AABB of this object. More... | |
Sphere | mWorldBoundingSphere |
AxisAlignedBox | mWorldDarkCapBounds |
World space AABB of this object's dark cap. 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... | |
Class providing a much simplified interface to generating manual objects with custom geometry.
Definition at line 106 of file OgreManualObject.h.
|
protectedinherited |
Definition at line 241 of file OgreAnimable.h.
typedef vector<ManualObjectSection*>::type Ogre::ManualObject::SectionList |
Definition at line 472 of file OgreManualObject.h.
|
inherited |
Definition at line 136 of file OgreShadowCaster.h.
|
inherited |
Definition at line 137 of file OgreShadowCaster.h.
Ogre::ManualObject::ManualObject | ( | const String & | name | ) |
|
virtual |
|
inlineprotectedinherited |
Get an updateable reference to animable value list.
Definition at line 267 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inlinevirtualinherited |
Get the creator of this object, if any (internal use only)
Definition at line 186 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns a pointer to the current list of lights for this object.
Definition at line 491 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Get the manager of this object, if any (internal use only)
Definition at line 190 of file OgreMovableObject.h.
|
virtualinherited |
return the full transformation of the parent sceneNode or the attachingPoint node
Reimplemented in Ogre::InstancedEntity.
|
virtualinherited |
Internal method called to notify the object that it has been attached to a node.
Reimplemented in Ogre::Entity, Ogre::ParticleSystem, Ogre::Light, Ogre::PortalBase, and Ogre::InstancedEntity.
Referenced by Ogre::PortalBase::_notifyAttached().
|
inlinevirtualinherited |
Notify the object of it's creator (internal use only)
Definition at line 184 of file OgreMovableObject.h.
|
virtualinherited |
Internal method to notify the object of the camera to be used for the next rendering operation.
Reimplemented in Ogre::BillboardSet, Ogre::InstancedGeometry::BatchInstance, Ogre::Frustum, Ogre::StaticGeometry::Region, Ogre::Entity, Ogre::ParticleSystem, Ogre::InstanceBatch, Ogre::SimpleRenderable, and Ogre::MovablePlane.
|
inlinevirtualinherited |
Notify the object of it's manager (internal use only)
Definition at line 188 of file OgreMovableObject.h.
|
virtualinherited |
Internal method called to notify the object that it has been moved.
Reimplemented in Ogre::Light, Ogre::PortalBase, Ogre::InstancedEntity, and Ogre::PCZLight.
|
virtual |
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 396 of file OgreMovableObject.h.
|
inlinevirtualinherited |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 424 of file OgreMovableObject.h.
|
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 |
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 |
Completely clear the contents of the object.
|
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 |
Convert this object to a Mesh.
meshName | The name to give the mesh |
groupName | The resource group to create the mesh in |
|
protectedvirtual |
Copy current temp vertex into buffer.
|
inlineprotectedinherited |
Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
Definition at line 254 of file OgreAnimable.h.
|
inlinevirtualinherited |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light.
Definition at line 320 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtualinherited |
|
virtual |
Finish defining the object and compile the final renderable version.
|
virtual |
Estimate the number of indices ahead of time.
|
virtual |
Estimate the number of vertices ahead of time.
|
protectedvirtualinherited |
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. |
|
staticinherited |
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. |
|
protectedvirtualinherited |
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. |
indexBufferUsedSize | If the rest of buffer is enough than it would be locked with HBL_NO_OVERWRITE semantic and indexBufferUsedSize would be increased, otherwise HBL_DISCARD would be used and indexBufferUsedSize would be reset. |
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. |
|
inlineprotectedvirtualinherited |
Get the name of the animable dictionary for this class.
Reimplemented in Ogre::Light.
Definition at line 249 of file OgreAnimable.h.
References Ogre::StringUtil::BLANK.
|
inlineinherited |
Gets a list of animable value names for this object.
Definition at line 295 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtual |
Implements Ogre::MovableObject.
|
virtual |
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
Returns whether shadow casting is enabled for this object.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 521 of file OgreMovableObject.h.
|
virtual |
Get the number of indices in the section currently being defined (returns 0 if no section is in progress).
|
virtual |
Get the number of vertices in the section currently being defined (returns 0 if no section is in progress).
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinestaticinherited |
Get the default query flags for all future MovableObject instances.
Definition at line 411 of file OgreMovableObject.h.
|
inlinestaticinherited |
Get the default visibility flags for all future MovableObject instances.
Definition at line 439 of file OgreMovableObject.h.
|
inlinevirtual |
Gets whether this object is marked as dynamic.
Definition at line 161 of file OgreManualObject.h.
|
virtual |
Implement this method to enable stencil shadows.
Implements Ogre::ShadowCaster.
|
protectedinherited |
Helper method for calculating extrusion distance.
|
inline |
Gets whether or not the declaration order is to be kept or not.
Definition at line 379 of file OgreManualObject.h.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Get a bitwise mask which will filter the lights affecting this object.
Definition at line 476 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Gets the current listener for this object.
Definition at line 450 of file OgreMovableObject.h.
|
virtual |
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
Returns the name of this object.
Definition at line 193 of file OgreMovableObject.h.
unsigned int Ogre::ManualObject::getNumSections | ( | void | ) | const |
Retrieves the number of ManualObjectSection objects making up this ManualObject.
|
virtualinherited |
Returns the node to which this object is attached.
|
virtualinherited |
Returns the scene node to which this object is attached.
Get the distance to extrude for a point/spot light.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Returns the query flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 403 of file OgreMovableObject.h.
|
inherited |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
|
inlinevirtualinherited |
Gets the distance at which batches are no longer rendered.
Definition at line 305 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
Definition at line 318 of file OgreMovableObject.h.
|
virtualinherited |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
ManualObjectSection* Ogre::ManualObject::getSection | ( | unsigned int | index | ) | const |
Gets a pointer to a ManualObjectSection, i.e.
a part of a ManualObject.
|
virtual |
Implement this method to enable stencil shadows.
Implements Ogre::ShadowCaster.
|
virtualinherited |
Get the 'type flags' for this MovableObject.
Reimplemented in Ogre::BillboardSet, Ogre::Entity, Ogre::ParticleSystem, Ogre::Frustum, Ogre::StaticGeometry::Region, and Ogre::Light.
|
inline |
Returns whether or not to use an 'identity' projection.
Definition at line 324 of file OgreManualObject.h.
|
inline |
Returns whether or not to use an 'identity' view.
Definition at line 346 of file OgreManualObject.h.
|
inlinevirtualinherited |
Definition at line 334 of file OgreMovableObject.h.
|
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.
Definition at line 340 of file OgreMovableObject.h.
|
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.
Definition at line 346 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns the visibility flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 431 of file OgreMovableObject.h.
|
virtualinherited |
Gets this object whether to be visible or not, if it has a renderable component.
|
virtualinherited |
Retrieves the axis-aligned bounding box for this object in world coordinates.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
virtualinherited |
Retrieves the worldspace bounding sphere for this object.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
virtual |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
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 4294967295. |
Referenced by Ogre::Volume::MeshBuilder::addCubeToManualObject().
|
inlineprotectedvirtualinherited |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
Reimplemented in Ogre::Light.
Definition at line 287 of file OgreAnimable.h.
|
virtualinherited |
|
inlinevirtualinherited |
Gets whether debug display of this object is enabled.
Definition at line 565 of file OgreMovableObject.h.
|
virtualinherited |
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.
Reimplemented in Ogre::InstancedEntity.
|
inlinevirtualinherited |
Gets whether the parent node is a TagPoint (or a SceneNode)
Definition at line 216 of file OgreMovableObject.h.
|
virtualinherited |
Returns whether or not this object is supposed to be visible or not.
Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.
|
virtual |
Add a vertex normal to the current vertex.
Add a vertex normal to the current vertex.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
virtual |
Add a vertex position, starting a new vertex at the same time.
Referenced by Ogre::Volume::MeshBuilder::addCubeToManualObject().
Add a vertex position, starting a new vertex at the same time.
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,i4 | 4 vertex indices from 0 to 4294967295 defining a quad. |
|
virtualinherited |
Gets a list of lights, ordered relative to how close they are to this movable object.
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 400 of file OgreMovableObject.h.
|
inlinevirtualinherited |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 428 of file OgreMovableObject.h.
|
protectedvirtual |
Delete temp buffers and reset init counts.
|
protectedvirtual |
Resize the temp index buffer?
|
protectedvirtual |
Resize the temp vertex buffer?
|
inline |
Sets the bounding box.
Definition at line 355 of file OgreManualObject.h.
|
inlineinherited |
Sets whether or not this object will cast shadows.
Definition at line 519 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets whether or not the debug display of this object is enabled.
Definition at line 563 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default query flags for all future MovableObject instances.
Definition at line 407 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default visibility flags for all future MovableObject instances.
Definition at line 435 of file OgreMovableObject.h.
|
inlinevirtual |
Use before defining geometry to indicate that you intend to update the geometry regularly and want the internal structure to reflect that.
Definition at line 159 of file OgreManualObject.h.
|
inline |
Sets whether or not to keep the original declaration order when queuing the renderables.
keepOrder | Whether to keep the declaration order or not. |
Definition at line 373 of file OgreManualObject.h.
|
virtualinherited |
Set a bitwise mask which will filter the lights affecting this object.
|
inlinevirtualinherited |
Sets a listener for this object.
Definition at line 446 of file OgreMovableObject.h.
|
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 |
|
inlinevirtualinherited |
Sets the query flags for this object.
Definition at line 392 of file OgreMovableObject.h.
|
inlinevirtualinherited |
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 299 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
pixelSize | Number of minimum pixels (the default is 0, which means objects are always rendered). |
Definition at line 312 of file OgreMovableObject.h.
|
virtualinherited |
Sets the render queue group this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.
|
virtualinherited |
Sets the render queue group and group priority this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
priority | The priority within a group to use. |
Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.
void Ogre::ManualObject::setUseIdentityProjection | ( | bool | useIdentityProjection | ) |
Sets whether or not to use an 'identity' projection.
void Ogre::ManualObject::setUseIdentityView | ( | bool | useIdentityView | ) |
Sets whether or not to use an 'identity' view.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 329 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the visibility flags for this object.
Definition at line 420 of file OgreMovableObject.h.
|
virtualinherited |
Tells this object whether to be visible or not, if it has a renderable component.
Reimplemented in Ogre::Light.
|
virtual |
Add a vertex tangent to the current vertex.
Add a vertex tangent to the current vertex.
|
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.
Add a texture coordinate to the current vertex.
|
virtual |
Add a texture coordinate to the current vertex.
|
virtual |
Add a texture coordinate to the current vertex.
|
virtual |
Add a texture coordinate to the current vertex.
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 4294967295 defining a face. |
|
protectedvirtualinherited |
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 |
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.
|
protected |
Bounding box.
Definition at line 521 of file OgreManualObject.h.
|
protected |
Any indexed geometry on any sections?
Definition at line 525 of file OgreManualObject.h.
|
protectedinherited |
Hidden because of distance?
Definition at line 128 of file OgreMovableObject.h.
|
protectedinherited |
Does this object cast shadows?
Definition at line 150 of file OgreMovableObject.h.
|
protectedinherited |
Creator of this object (if created by a factory)
Definition at line 112 of file OgreMovableObject.h.
|
protected |
Current section.
Definition at line 485 of file OgreManualObject.h.
|
protected |
Are we updating?
Definition at line 487 of file OgreManualObject.h.
|
protectedinherited |
Is debug display enabled?
Definition at line 121 of file OgreMovableObject.h.
|
protected |
Current declaration vertex size.
Definition at line 513 of file OgreManualObject.h.
|
protected |
Dynamic?
Definition at line 481 of file OgreManualObject.h.
|
protected |
Edge list, used if stencil shadow casting is enabled.
Definition at line 527 of file OgreManualObject.h.
|
protected |
Estimated index count.
Definition at line 517 of file OgreManualObject.h.
|
protected |
Estimated vertex count.
Definition at line 515 of file OgreManualObject.h.
|
protected |
First vertex indicator.
Definition at line 501 of file OgreManualObject.h.
|
protected |
Keep declaration order or let the queue optimize it.
Definition at line 535 of file OgreManualObject.h.
|
mutableprotectedinherited |
List of lights for this object.
Definition at line 158 of file OgreMovableObject.h.
|
mutableprotectedinherited |
The last frame that this light list was updated in.
Definition at line 160 of file OgreMovableObject.h.
|
protectedinherited |
the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable
Definition at line 163 of file OgreMovableObject.h.
|
protectedinherited |
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 155 of file OgreMovableObject.h.
|
protectedinherited |
SceneManager holding this object (if applicable)
Definition at line 114 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 126 of file OgreMovableObject.h.
|
protectedinherited |
Name of this object.
Definition at line 110 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 117 of file OgreMovableObject.h.
|
protectedinherited |
node to which this object is attached
Definition at line 116 of file OgreMovableObject.h.
|
protectedinherited |
Flags determining whether this object is included / excluded from scene queries.
Definition at line 140 of file OgreMovableObject.h.
|
protected |
Bounding sphere.
Definition at line 523 of file OgreManualObject.h.
|
protectedinherited |
Does rendering this object disabled by listener?
Definition at line 153 of file OgreMovableObject.h.
|
protectedinherited |
The render queue to use when rendering this object.
Definition at line 132 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 134 of file OgreMovableObject.h.
|
protectedinherited |
The render queue group to use when rendering this object.
Definition at line 136 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 138 of file OgreMovableObject.h.
|
staticprotectedinherited |
Static map of class name to list of animable value names.
Definition at line 243 of file OgreAnimable.h.
|
staticprotectedinherited |
Default query flags.
Definition at line 167 of file OgreMovableObject.h.
|
staticprotectedinherited |
Default visibility flags.
Definition at line 169 of file OgreMovableObject.h.
|
protected |
List of subsections.
Definition at line 483 of file OgreManualObject.h.
|
protected |
List of shadow renderables.
Definition at line 529 of file OgreManualObject.h.
|
protectedinherited |
Definition at line 124 of file OgreMovableObject.h.
|
protected |
System-memory buffer whilst we establish the size required.
Definition at line 509 of file OgreManualObject.h.
|
protected |
System memory allocation size, in bytes.
Definition at line 511 of file OgreManualObject.h.
|
protected |
Temp storage.
Definition at line 499 of file OgreManualObject.h.
|
protected |
System-memory buffer whilst we establish the size required.
Definition at line 505 of file OgreManualObject.h.
|
protected |
Temp vertex data to copy?
Definition at line 503 of file OgreManualObject.h.
|
protected |
System memory allocation size, in bytes.
Definition at line 507 of file OgreManualObject.h.
|
protected |
Current texture coordinate.
Definition at line 519 of file OgreManualObject.h.
|
protectedinherited |
Upper distance to still render.
Definition at line 123 of file OgreMovableObject.h.
|
protected |
Whether to use identity projection for sections.
Definition at line 531 of file OgreManualObject.h.
|
protected |
Whether to use identity view for sections.
Definition at line 533 of file OgreManualObject.h.
|
protectedinherited |
User objects binding.
Definition at line 130 of file OgreMovableObject.h.
|
protectedinherited |
Flags determining whether this object is visible (compared to SceneManager mask)
Definition at line 142 of file OgreMovableObject.h.
|
protectedinherited |
Is this object visible?
Definition at line 119 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Cached world AABB of this object.
Definition at line 144 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 146 of file OgreMovableObject.h.
|
mutableprotectedinherited |
World space AABB of this object's dark cap.
Definition at line 148 of file OgreMovableObject.h.