#include <OgreLight.h>
Public Types | |
| enum | LightTypes { LT_POINT, LT_DIRECTIONAL, LT_SPOTLIGHT } |
| Defines the type of light. More... | |
| typedef std::vector < ShadowRenderable * > | ShadowRenderableList |
| typedef VectorIterator < ShadowRenderableList > | ShadowRenderableListIterator |
Public Member Functions | |
| void | _calcTempSquareDist (const Vector3 &worldPos) |
| internal method for calculating current squared distance from some world position | |
| Light () | |
| Default constructor (for Python mainly). | |
| Light (const String &name) | |
| Normal constructor. | |
| ~Light () | |
| Standard destructor. | |
| void | setType (LightTypes type) |
| Sets the type of light - see LightTypes for more info. | |
| LightTypes | getType (void) const |
| Returns the light type. | |
| void | setDiffuseColour (Real red, Real green, Real blue) |
| Sets the colour of the diffuse light given off by this source. | |
| void | setDiffuseColour (const ColourValue &colour) |
| Sets the colour of the diffuse light given off by this source. | |
| const ColourValue & | getDiffuseColour (void) const |
| Returns the colour of the diffuse light given off by this light source (see setDiffuseColour for more info). | |
| void | setSpecularColour (Real red, Real green, Real blue) |
| Sets the colour of the specular light given off by this source. | |
| void | setSpecularColour (const ColourValue &colour) |
| Sets the colour of the specular light given off by this source. | |
| const ColourValue & | getSpecularColour (void) const |
| Returns the colour of specular light given off by this light source. | |
| void | setAttenuation (Real range, Real constant, Real linear, Real quadratic) |
| Sets the attenuation parameters of the light source ie how it diminishes with distance. | |
| Real | getAttenuationRange (void) const |
| Returns the absolute upper range of the light. | |
| Real | getAttenuationConstant (void) const |
| Returns the constant factor in the attenuation formula. | |
| Real | getAttenuationLinear (void) const |
| Returns the linear factor in the attenuation formula. | |
| Real | getAttenuationQuadric (void) const |
| Returns the quadric factor in the attenuation formula. | |
| void | setPosition (Real x, Real y, Real z) |
| Sets the position of the light. | |
| void | setPosition (const Vector3 &vec) |
| Sets the position of the light. | |
| const Vector3 & | getPosition (void) const |
| Returns the position of the light. | |
| void | setDirection (Real x, Real y, Real z) |
| Sets the direction in which a light points. | |
| void | setDirection (const Vector3 &vec) |
| Sets the direction in which a light points. | |
| const Vector3 & | getDirection (void) const |
| Returns the light's direction. | |
| void | setSpotlightRange (const Radian &innerAngle, const Radian &outerAngle, Real falloff=1.0) |
| Sets the range of a spotlight, i.e. | |
| const Radian & | getSpotlightInnerAngle (void) const |
| Returns the angle covered by the spotlights inner cone. | |
| const Radian & | getSpotlightOuterAngle (void) const |
| Returns the angle covered by the spotlights outer cone. | |
| Real | getSpotlightFalloff (void) const |
| Returns the falloff between the inner and outer cones of the spotlight. | |
| void | setSpotlightInnerAngle (const Radian &val) |
| Sets the angle covered by the spotlights inner cone. | |
| void | setSpotlightOuterAngle (const Radian &val) |
| Sets the angle covered by the spotlights outer cone. | |
| void | setSpotlightFalloff (Real val) |
| Sets the falloff between the inner and outer cones of the spotlight. | |
| void | setPowerScale (Real power) |
| Set a scaling factor to indicate the relative power of a light. | |
| Real | getPowerScale (void) const |
| Set the scaling factor which indicates the relative power of a light. | |
| void | _notifyAttached (Node *parent, bool isTagPoint=false) |
| Overridden from MovableObject. | |
| void | _notifyMoved (void) |
| Overridden from MovableObject. | |
| const AxisAlignedBox & | getBoundingBox (void) const |
| Overridden from MovableObject. | |
| void | _updateRenderQueue (RenderQueue *queue) |
| Overridden from MovableObject. | |
| const String & | getMovableType (void) const |
| Overridden from MovableObject. | |
| const Vector3 & | getDerivedPosition (void) const |
| Retrieves the position of the light including any transform from nodes it is attached to. | |
| const Vector3 & | getDerivedDirection (void) const |
| Retrieves the direction of the light including any transform from nodes it is attached to. | |
| void | setVisible (bool visible) |
| Overridden from MovableObject. | |
| Real | getBoundingRadius (void) const |
| Overridden from MovableObject. | |
| Vector4 | getAs4DVector (void) const |
| Gets the details of this light as a 4D vector. | |
| virtual const PlaneBoundedVolume & | _getNearClipVolume (const Camera *const cam) const |
| Internal method for calculating the 'near clip volume', which is the volume formed between the near clip rectangle of the camera and the light. | |
| virtual const PlaneBoundedVolumeList & | _getFrustumClipVolumes (const Camera *const cam) const |
| Internal method for calculating the clip volumes outside of the frustum which can be used to determine which objects are casting shadow on the frustum as a whole. | |
| uint32 | getTypeFlags (void) const |
| Override to return specific type flag. | |
| AnimableValuePtr | createAnimableValue (const String &valueName) |
| Create a reference-counted AnimableValuePtr for the named value.
| |
| void | setCustomShadowCameraSetup (const ShadowCameraSetupPtr &customShadowSetup) |
| Set this light to use a custom shadow camera when rendering texture shadows. | |
| void | resetCustomShadowCameraSetup (void) |
| Reset the shadow camera setup to the default. | |
| const ShadowCameraSetupPtr & | getCustomShadowCameraSetup (void) const |
| return a pointer to the custom shadow camera setup (null means use SceneManager global version). | |
| virtual void | _notifyCreator (MovableObjectFactory *fact) |
| Notify the object of it's creator (internal use only). | |
| virtual MovableObjectFactory * | _getCreator (void) const |
| Get the creator of this object, if any (internal use only). | |
| virtual void | _notifyManager (SceneManager *man) |
| Notify the object of it's manager (internal use only). | |
| virtual SceneManager * | _getManager (void) const |
| Get the manager of this object, if any (internal use only). | |
| virtual const String & | getName (void) const |
| Returns the name of this object. | |
| virtual Node * | getParentNode (void) const |
| Returns the node to which this object is attached. | |
| virtual SceneNode * | getParentSceneNode (void) const |
| Returns the scene node to which this object is attached. | |
| virtual bool | 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 | _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 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. | |
| 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. | |
| Real | getPointExtrusionDistance (const Light *l) const |
| Get the distance to extrude for a point/spot light. | |
| const StringVector & | getAnimableValueNames (void) const |
| Gets a list of animable value names for this object. | |
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 | |
| Real | tempSquareDist |
| Temp tag used for sorting. | |
Protected Types | |
| typedef std::map < String, StringVector > | AnimableDictionaryMap |
Protected Member Functions | |
| virtual void | update (void) const |
| internal method for synchronising with parent node (if any) | |
| const String & | getAnimableDictionaryName (void) const |
| Get the name of the animable dictionary for this class.
| |
| void | initialiseAnimableDictionary (StringVector &vec) const |
| Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. | |
| 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. | |
| 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. | |
Protected Attributes | |
| LightTypes | mLightType |
| Vector3 | mPosition |
| ColourValue | mDiffuse |
| ColourValue | mSpecular |
| Vector3 | mDirection |
| Radian | mSpotOuter |
| Radian | mSpotInner |
| Real | mSpotFalloff |
| Real | mRange |
| Real | mAttenuationConst |
| Real | mAttenuationLinear |
| Real | mAttenuationQuad |
| Real | mPowerScale |
| Vector3 | mDerivedPosition |
| Vector3 | mDerivedDirection |
| PlaneBoundedVolume | mNearClipVolume |
| PlaneBoundedVolumeList | mFrustumClipVolumes |
| bool | mDerivedTransformDirty |
| Is the derived transform dirty? | |
| ShadowCameraSetupPtr | mCustomShadowCameraSetup |
| Pointer to a custom shadow camera setup. | |
| 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 String | msMovableType |
| Shared class-level name for Movable type. | |
| 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. | |
Definition at line 67 of file OgreLight.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.
Defines the type of light.
Definition at line 76 of file OgreLight.h.
| Ogre::Light::Light | ( | ) |
Default constructor (for Python mainly).
| Ogre::Light::Light | ( | const String & | name | ) |
Normal constructor.
Should not be called directly, but rather the SceneManager::createLight method should be used.
| Ogre::Light::~Light | ( | ) |
Standard destructor.
| void Ogre::Light::_calcTempSquareDist | ( | const Vector3 & | worldPos | ) |
internal method for calculating current squared distance from some world position
| void Ogre::Light::setType | ( | LightTypes | type | ) |
Sets the type of light - see LightTypes for more info.
| LightTypes Ogre::Light::getType | ( | void | ) | const |
Returns the light type.
Sets the colour of the diffuse light given off by this source.
| void Ogre::Light::setDiffuseColour | ( | const ColourValue & | colour | ) |
Sets the colour of the diffuse light given off by this source.
| const ColourValue& Ogre::Light::getDiffuseColour | ( | void | ) | const |
Returns the colour of the diffuse light given off by this light source (see setDiffuseColour for more info).
Sets the colour of the specular light given off by this source.
| void Ogre::Light::setSpecularColour | ( | const ColourValue & | colour | ) |
Sets the colour of the specular light given off by this source.
| const ColourValue& Ogre::Light::getSpecularColour | ( | void | ) | const |
Returns the colour of specular light given off by this light source.
Sets the attenuation parameters of the light source ie how it diminishes with distance.
| range | The absolute upper range of the light in world units | |
| constant | The constant factor in the attenuation formula: 1.0 means never attenuate, 0.0 is complete attenuation | |
| linear | The linear factor in the attenuation formula: 1 means attenuate evenly over the distance | |
| quadratic | The quadratic factor in the attenuation formula: adds a curvature to the attenuation formula. |
| Real Ogre::Light::getAttenuationRange | ( | void | ) | const |
Returns the absolute upper range of the light.
| Real Ogre::Light::getAttenuationConstant | ( | void | ) | const |
Returns the constant factor in the attenuation formula.
| Real Ogre::Light::getAttenuationLinear | ( | void | ) | const |
Returns the linear factor in the attenuation formula.
| Real Ogre::Light::getAttenuationQuadric | ( | void | ) | const |
Returns the quadric factor in the attenuation formula.
Sets the position of the light.
| void Ogre::Light::setPosition | ( | const Vector3 & | vec | ) |
Sets the position of the light.
| const Vector3& Ogre::Light::getPosition | ( | void | ) | const |
Returns the position of the light.
Sets the direction in which a light points.
| void Ogre::Light::setDirection | ( | const Vector3 & | vec | ) |
Sets the direction in which a light points.
| const Vector3& Ogre::Light::getDirection | ( | void | ) | const |
Returns the light's direction.
| void Ogre::Light::setSpotlightRange | ( | const Radian & | innerAngle, | |
| const Radian & | outerAngle, | |||
| Real | falloff = 1.0 | |||
| ) |
Sets the range of a spotlight, i.e.
the angle of the inner and outer cones and the rate of falloff between them.
| innerAngle | Angle covered by the bright inner cone The inner cone applicable only to Direct3D, it'll always treat as zero in OpenGL. | |
| outerAngle | Angle covered by the outer cone | |
| falloff | The rate of falloff between the inner and outer cones. 1.0 means a linear falloff, less means slower falloff, higher means faster falloff. |
| const Radian& Ogre::Light::getSpotlightInnerAngle | ( | void | ) | const |
Returns the angle covered by the spotlights inner cone.
| const Radian& Ogre::Light::getSpotlightOuterAngle | ( | void | ) | const |
Returns the angle covered by the spotlights outer cone.
| Real Ogre::Light::getSpotlightFalloff | ( | void | ) | const |
Returns the falloff between the inner and outer cones of the spotlight.
| void Ogre::Light::setSpotlightInnerAngle | ( | const Radian & | val | ) |
Sets the angle covered by the spotlights inner cone.
| void Ogre::Light::setSpotlightOuterAngle | ( | const Radian & | val | ) |
Sets the angle covered by the spotlights outer cone.
| void Ogre::Light::setSpotlightFalloff | ( | Real | val | ) |
Sets the falloff between the inner and outer cones of the spotlight.
| void Ogre::Light::setPowerScale | ( | Real | power | ) |
Set a scaling factor to indicate the relative power of a light.
| power | The power rating of this light, default is 1.0. |
| Real Ogre::Light::getPowerScale | ( | void | ) | const |
Set the scaling factor which indicates the relative power of a light.
| void Ogre::Light::_notifyAttached | ( | Node * | parent, | |
| bool | isTagPoint = false | |||
| ) | [virtual] |
| void Ogre::Light::_notifyMoved | ( | void | ) | [virtual] |
| const AxisAlignedBox& Ogre::Light::getBoundingBox | ( | void | ) | const [virtual] |
| void Ogre::Light::_updateRenderQueue | ( | RenderQueue * | queue | ) | [virtual] |
| const String& Ogre::Light::getMovableType | ( | void | ) | const [virtual] |
| const Vector3& Ogre::Light::getDerivedPosition | ( | void | ) | const |
Retrieves the position of the light including any transform from nodes it is attached to.
| const Vector3& Ogre::Light::getDerivedDirection | ( | void | ) | const |
Retrieves the direction of the light including any transform from nodes it is attached to.
| void Ogre::Light::setVisible | ( | bool | visible | ) | [virtual] |
Overridden from MovableObject.
Reimplemented from Ogre::MovableObject.
| Real Ogre::Light::getBoundingRadius | ( | void | ) | const [virtual] |
Overridden from MovableObject.
Implements Ogre::MovableObject.
Definition at line 323 of file OgreLight.h.
| Vector4 Ogre::Light::getAs4DVector | ( | void | ) | const |
Gets the details of this light as a 4D vector.
| virtual const PlaneBoundedVolume& Ogre::Light::_getNearClipVolume | ( | const Camera *const | cam | ) | const [virtual] |
Internal method for calculating the 'near clip volume', which is the volume formed between the near clip rectangle of the camera and the light.
| virtual const PlaneBoundedVolumeList& Ogre::Light::_getFrustumClipVolumes | ( | const Camera *const | cam | ) | const [virtual] |
Internal method for calculating the clip volumes outside of the frustum which can be used to determine which objects are casting shadow on the frustum as a whole.
| uint32 Ogre::Light::getTypeFlags | ( | void | ) | const [virtual] |
| AnimableValuePtr Ogre::Light::createAnimableValue | ( | const String & | valueName | ) | [virtual] |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented from Ogre::AnimableObject.
| void Ogre::Light::setCustomShadowCameraSetup | ( | const ShadowCameraSetupPtr & | customShadowSetup | ) |
Set this light to use a custom shadow camera when rendering texture shadows.
| void Ogre::Light::resetCustomShadowCameraSetup | ( | void | ) |
| const ShadowCameraSetupPtr& Ogre::Light::getCustomShadowCameraSetup | ( | void | ) | const |
return a pointer to the custom shadow camera setup (null means use SceneManager global version).
| virtual void Ogre::Light::update | ( | void | ) | const [protected, virtual] |
internal method for synchronising with parent node (if any)
| const String& Ogre::Light::getAnimableDictionaryName | ( | void | ) | const [protected, virtual] |
Get the name of the animable dictionary for this class.
Reimplemented from Ogre::AnimableObject.
| void Ogre::Light::initialiseAnimableDictionary | ( | StringVector & | vec | ) | const [protected, virtual] |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
Reimplemented from Ogre::AnimableObject.
| 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 bool Ogre::MovableObject::isAttached | ( | void | ) | const [virtual, inherited] |
| virtual bool Ogre::MovableObject::isInScene | ( | void | ) | const [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 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.
| 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 415 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 417 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 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.
| 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 |
| 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.
| 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.
LightTypes Ogre::Light::mLightType [protected] |
Definition at line 385 of file OgreLight.h.
Vector3 Ogre::Light::mPosition [protected] |
Definition at line 386 of file OgreLight.h.
ColourValue Ogre::Light::mDiffuse [protected] |
Definition at line 387 of file OgreLight.h.
ColourValue Ogre::Light::mSpecular [protected] |
Definition at line 388 of file OgreLight.h.
Vector3 Ogre::Light::mDirection [protected] |
Definition at line 390 of file OgreLight.h.
Radian Ogre::Light::mSpotOuter [protected] |
Definition at line 392 of file OgreLight.h.
Radian Ogre::Light::mSpotInner [protected] |
Definition at line 393 of file OgreLight.h.
Real Ogre::Light::mSpotFalloff [protected] |
Definition at line 394 of file OgreLight.h.
Real Ogre::Light::mRange [protected] |
Definition at line 395 of file OgreLight.h.
Real Ogre::Light::mAttenuationConst [protected] |
Definition at line 396 of file OgreLight.h.
Real Ogre::Light::mAttenuationLinear [protected] |
Definition at line 397 of file OgreLight.h.
Real Ogre::Light::mAttenuationQuad [protected] |
Definition at line 398 of file OgreLight.h.
Real Ogre::Light::mPowerScale [protected] |
Definition at line 399 of file OgreLight.h.
Vector3 Ogre::Light::mDerivedPosition [mutable, protected] |
Definition at line 402 of file OgreLight.h.
Vector3 Ogre::Light::mDerivedDirection [mutable, protected] |
Definition at line 403 of file OgreLight.h.
String Ogre::Light::msMovableType [static, protected] |
PlaneBoundedVolume Ogre::Light::mNearClipVolume [mutable, protected] |
Definition at line 408 of file OgreLight.h.
PlaneBoundedVolumeList Ogre::Light::mFrustumClipVolumes [mutable, protected] |
Definition at line 409 of file OgreLight.h.
bool Ogre::Light::mDerivedTransformDirty [mutable, protected] |
ShadowCameraSetupPtr Ogre::Light::mCustomShadowCameraSetup [mutable, 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 Mon Jun 16 12:50:17 2008