Ogre2PointLight Class Reference
Ogre 2.x implementation of the point light class. More...
#include <Ogre2Light.hh>
Public Member Functions | |
| virtual | ~Ogre2PointLight () |
| Destructor. More... | |
 Public Member Functions inherited from BasePointLight< Ogre2Light > | |
| virtual | ~BasePointLight () |
| Public Member Functions inherited from PointLight | |
| virtual | ~PointLight () |
| Destructor. More... | |
| Public Member Functions inherited from Light | |
| virtual | ~Light () |
| Destructor. More... | |
| Public Member Functions inherited from Node | |
| virtual | ~Node () |
| Destructor. More... | |
| virtual unsigned int | ChildCount () const =0 |
| Get number of child nodes. More... | |
| virtual math::Pose3d | InitialLocalPose () const =0 |
| Get the initial local pose. More... | |
| virtual math::Pose3d | LocalPose () const =0 |
| Get the local pose. More... | |
| virtual math::Vector3d | LocalPosition () const =0 |
| Get the local position. More... | |
| virtual math::Quaterniond | LocalRotation () const =0 |
| Get the local rotation. More... | |
| virtual math::Vector3d | Origin () const =0 |
| Get position of origin. More... | |
| virtual math::Pose3d | WorldPose () const =0 |
| Get the world pose. More... | |
| virtual math::Vector3d | WorldPosition () const =0 |
| Get the world position. More... | |
| virtual math::Quaterniond | WorldRotation () const =0 |
| Get the world rotation. More... | |
| virtual math::Vector3d | WorldScale () const =0 |
| Get the world scale. More... | |
| Public Member Functions inherited from Object | |
| virtual | ~Object () |
| Destructor. More... | |
| virtual unsigned int | Id () const =0 |
| Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
| virtual std::string | Name () const =0 |
| Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More... | |
| virtual void | PostRender ()=0 |
| Post process this object and any of its children after rendering. More... | |
| virtual ScenePtr | Scene () const =0 |
| Get the Scene that created this object. More... | |
| Public Member Functions inherited from Ogre2Light | |
| virtual | ~Ogre2Light () |
| Destructor. More... | |
| virtual double | AttenuationConstant () const override |
| Get the attenuation constant value. More... | |
| virtual double | AttenuationLinear () const override |
| Get the attenuation linear value. More... | |
| virtual double | AttenuationQuadratic () const override |
| Get the attenuation quadratic value. More... | |
| virtual double | AttenuationRange () const override |
| Get the attenuation range. More... | |
| virtual bool | CastShadows () const override |
| Determine if this light cast shadows. More... | |
| virtual void | Destroy () override |
| Destroy the light. More... | |
| virtual math::Color | DiffuseColor () const override |
| Get the diffuse color. More... | |
| virtual double | Intensity () const override |
| Get the light intensity. More... | |
| virtual Ogre::Light * | Light () const |
| Get a pointer to ogre light. More... | |
| virtual void | SetAttenuationConstant (double _value) override |
| Set the attenuation constant value. More... | |
| virtual void | SetAttenuationLinear (double _value) override |
| Set the attenuation linear value. More... | |
| virtual void | SetAttenuationQuadratic (double _value) override |
| Set the attenuation quadratic value. More... | |
| virtual void | SetAttenuationRange (double _range) override |
| Set the attenuation range. More... | |
| virtual void | SetCastShadows (bool _castShadows) override |
| Specify if this light should cast shadows. More... | |
| virtual void | SetDiffuseColor (const math::Color &_color) override |
| Set the diffuse color. More... | |
| virtual void | SetIntensity (double _intensity) override |
| Set the light intensity. More... | |
| virtual void | SetSpecularColor (const math::Color &_color) override |
| Set the specular color. More... | |
| virtual math::Color | SpecularColor () const override |
| Get the specular color. More... | |
| Public Member Functions inherited from BaseLight< Ogre2Node > | |
| virtual | ~BaseLight () |
| virtual void | SetDiffuseColor (double _r, double _g, double _b, double _a=1.0) |
| Set the diffuse color. More... | |
| virtual void | SetSpecularColor (double _r, double _g, double _b, double _a=1.0) |
| Set the specular color. More... | |
| Public Member Functions inherited from Ogre2Node | |
| virtual | ~Ogre2Node () |
| Destructor. More... | |
| virtual bool | HasParent () const override |
| Determine if this Node is attached to another Node. More... | |
| virtual bool | InheritScale () const override |
| Determine if this node inherits scale from this parent. More... | |
| virtual math::Vector3d | LocalScale () const override |
| Get the local scale. More... | |
| virtual Ogre::SceneNode * | Node () const |
| Get a pointer to the underlying scene node. More... | |
| virtual NodePtr | Parent () const override |
| Get the parent Node. More... | |
| virtual void | SetInheritScale (bool _inherit) override |
| Specify if this node inherits scale from its parent. More... | |
| Public Member Functions inherited from BaseNode< Ogre2Object > | |
| virtual | ~BaseNode () |
| virtual void | AddChild (NodePtr _child) override |
| Add the given node to this node. If the given node is already a child, no work will be done. More... | |
| virtual NodePtr | ChildById (unsigned int _id) const override |
| Get node with given ID. If no child exists with given ID, NULL will be returned. More... | |
| virtual NodePtr | ChildByIndex (unsigned int _index) const override |
| Get node at given index. If no child exists at given index, NULL will be returned. More... | |
| virtual NodePtr | ChildByName (const std::string &_name) const override |
| Get node with given name. If no child exists with given name, NULL will be returned. More... | |
| virtual unsigned int | ChildCount () const override |
| Get number of child nodes. More... | |
| virtual bool | HasChild (ConstNodePtr _child) const override |
| Determine if given node is an attached child. More... | |
| virtual bool | HasChildId (unsigned int _id) const override |
| Determine if node with given ID is an attached child. More... | |
| virtual bool | HasChildName (const std::string &_name) const override |
| Determine if node with given name is an attached child. More... | |
| virtual bool | HasUserData (const std::string &_key) const override |
| Check if node has custom data. More... | |
| virtual bool | InheritScale () const override=0 |
| Determine if this node inherits scale from this parent. More... | |
| virtual math::Pose3d | InitialLocalPose () const override |
| Get the initial local pose. More... | |
| virtual math::Pose3d | LocalPose () const override |
| Get the local pose. More... | |
| virtual math::Vector3d | LocalPosition () const override |
| Get the local position. More... | |
| virtual math::Quaterniond | LocalRotation () const override |
| Get the local rotation. More... | |
| virtual math::Vector3d | LocalScale () const override=0 |
| Get the local scale. More... | |
| virtual math::Vector3d | Origin () const override |
| Get position of origin. More... | |
| virtual NodePtr | Parent () const override=0 |
| Get the parent Node. More... | |
| virtual void | PreRender () override |
| Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More... | |
| virtual NodePtr | RemoveChild (NodePtr _child) override |
| Remove (detach) the given node from this node. If the given node is not a child of this node, no work will be done. More... | |
| virtual NodePtr | RemoveChildById (unsigned int _id) override |
| Remove (detach) the node with the given ID from this node. If the specified node is not a child of this node, no work will be done. More... | |
| virtual NodePtr | RemoveChildByIndex (unsigned int _index) override |
| Remove (detach) the node at the given index from this node. If the specified node is not a child of this node, no work will be done. More... | |
| virtual NodePtr | RemoveChildByName (const std::string &_name) override |
| Remove (detach) the node with the given name from this node. If the specified node is not a child of this node, no work will be done. More... | |
| virtual void | RemoveChildren () override |
| Remove all child nodes from this node This detaches all the child nodes but does not destroy them. More... | |
| virtual void | RemoveParent () override |
| Detach this Node from its parent. If this Node does not have a parent, no work will be done. More... | |
| virtual void | Scale (const math::Vector3d &_scale) override |
| Scale the current scale by the given scalars. More... | |
| virtual void | Scale (double _scale) override |
| Scale the current scale by the given scalar. The given scalar will be assigned to the x, y, and z coordinates. More... | |
| virtual void | Scale (double _x, double _y, double _z) override |
| Scale the current scale by the given scalars. More... | |
| virtual void | SetLocalPose (const math::Pose3d &_pose) override |
| Set the local pose. More... | |
| virtual void | SetLocalPosition (const math::Vector3d &_position) override |
| Set the local position. More... | |
| virtual void | SetLocalPosition (double _x, double _y, double _z) override |
| Set the local position. More... | |
| virtual void | SetLocalRotation (const math::Quaterniond &_rotation) override |
| Set the local rotation. More... | |
| virtual void | SetLocalRotation (double _r, double _p, double _y) override |
| Set the local rotation. More... | |
| virtual void | SetLocalRotation (double _w, double _x, double _y, double _z) override |
| Set the local rotation. More... | |
| virtual void | SetLocalScale (const math::Vector3d &_scale) override |
| Set the local scale. More... | |
| virtual void | SetLocalScale (double _scale) override |
| Set the local scale. The given scale will be assigned to the x, y, and z coordinates. More... | |
| virtual void | SetLocalScale (double _x, double _y, double _z) override |
| Set the local scale. More... | |
| virtual void | SetOrigin (const math::Vector3d &_origin) override |
| Set position of origin. The position should be relative to the original origin of the geometry. More... | |
| virtual void | SetOrigin (double _x, double _y, double _z) override |
| Set position of origin. The position should be relative to the original origin of the geometry. More... | |
| virtual void | SetUserData (const std::string &_key, Variant _value) override |
| Store any custom data associated with this node. More... | |
| virtual void | SetWorldPose (const math::Pose3d &_pose) override |
| Set the world pose. More... | |
| virtual void | SetWorldPosition (const math::Vector3d &_position) override |
| Set the world position. More... | |
| virtual void | SetWorldPosition (double _x, double _y, double _z) override |
| Set the world position. More... | |
| virtual void | SetWorldRotation (const math::Quaterniond &_rotation) override |
| Set the world rotation. More... | |
| virtual void | SetWorldRotation (double _r, double _p, double _y) override |
| Set the world rotation. More... | |
| virtual void | SetWorldRotation (double _w, double _x, double _y, double _z) override |
| Set the world rotation. More... | |
| virtual void | SetWorldScale (const math::Vector3d &_scale) override |
| Set the world scale. More... | |
| virtual void | SetWorldScale (double _scale) override |
| Set the world scale. The given scale will be assigned to the x, y, and z coordinates. More... | |
| virtual void | SetWorldScale (double _x, double _y, double _z) override |
| Set the world scale. More... | |
| virtual Variant | UserData (const std::string &_key) const override |
| Get custom data stored in this node. More... | |
| virtual math::Pose3d | WorldPose () const override |
| Get the world pose. More... | |
| virtual math::Vector3d | WorldPosition () const override |
| Get the world position. More... | |
| virtual math::Quaterniond | WorldRotation () const override |
| Get the world rotation. More... | |
| virtual math::Vector3d | WorldScale () const override |
| Get the world scale. More... | |
| virtual math::Pose3d | WorldToLocal (const math::Pose3d &_pose) const override |
| Convert given world pose to local pose. More... | |
| Public Member Functions inherited from Ogre2Object | |
| virtual | ~Ogre2Object () |
| Destructor. More... | |
| virtual ScenePtr | Scene () const override |
| Public Member Functions inherited from BaseObject | |
| virtual | ~BaseObject () |
| virtual unsigned int | Id () const override |
| virtual std::string | Name () const override |
| virtual void | PostRender () override |
Protected Member Functions | |
| Ogre2PointLight () | |
| Constructor. More... | |
| Protected Member Functions inherited from BasePointLight< Ogre2Light > | |
| BasePointLight () | |
| Protected Member Functions inherited from Ogre2Light | |
| Ogre2Light () | |
| Constructor. More... | |
| virtual void | Init () override |
| Initialize the light. More... | |
| Protected Member Functions inherited from BaseLight< Ogre2Node > | |
| BaseLight () | |
| virtual void | Reset () |
| Protected Member Functions inherited from Ogre2Node | |
| Ogre2Node () | |
| Constructor. More... | |
| virtual bool | AttachChild (NodePtr _child) override |
| virtual NodeStorePtr | Children () const override |
| virtual bool | DetachChild (NodePtr _child) override |
| virtual void | Load () override |
| virtual math::Pose3d | RawLocalPose () const override |
| virtual math::Vector3d | RawLocalPosition () const |
| Get the raw local position of the node. More... | |
| virtual math::Quaterniond | RawLocalRotation () const |
| Get the raw local rotation of the node. More... | |
| virtual void | SetLocalScaleImpl (const math::Vector3d &_scale) override |
| Implementation of the SetLocalScale function. More... | |
| virtual void | SetParent (Ogre2NodePtr _parent) |
| Set the parent node. More... | |
| virtual void | SetRawLocalPose (const math::Pose3d &_Pose3d) override |
| virtual void | SetRawLocalPosition (const math::Vector3d &_position) |
| Set the raw local position of the node. More... | |
| virtual void | SetRawLocalRotation (const math::Quaterniond &_rotation) |
| Set the raw local rotation of the node. More... | |
| Protected Member Functions inherited from BaseNode< Ogre2Object > | |
| BaseNode () | |
| virtual NodeStorePtr | Children () const=0 |
| virtual void | PreRenderChildren () |
| virtual math::Pose3d | RawLocalPose () const=0 |
| Protected Member Functions inherited from Ogre2Object | |
| Ogre2Object () | |
| Constructor. More... | |
| Protected Member Functions inherited from BaseObject | |
| BaseObject () | |
Additional Inherited Members | |
| Protected Attributes inherited from Ogre2Light | |
| double | attenConstant = 1.0 |
| Attenuation constant value. More... | |
| double | attenLinear = 0.0 |
| Attenuation linear factor. More... | |
| double | attenQuadratic = 0.0 |
| Attenuation quadratic factor. More... | |
| double | attenRange = 100.0 |
| Attenuation range. More... | |
| Ogre::Light * | ogreLight = nullptr |
| Pointer to ogre light. More... | |
| Ogre::Light::LightTypes | ogreLightType |
| Light type. More... | |
| Protected Attributes inherited from Ogre2Node | |
| Ogre2NodeStorePtr | children |
| A list of child nodes. More... | |
| Ogre::SceneNode * | ogreNode = nullptr |
| The underlying ogre scene node. More... | |
| Ogre2NodePtr | parent |
| Pointer to the parent ogre node. More... | |
| Protected Attributes inherited from BaseNode< Ogre2Object > | |
| gz::math::Pose3d | initialLocalPose |
| Initial local pose for this node. More... | |
| bool | initialLocalPoseSet |
| Flag to indicate whether initial local pose is set for this node. More... | |
| math::Vector3d | origin |
| std::map< std::string, Variant > | userData |
| A map of custom key value data. More... | |
| Protected Attributes inherited from Ogre2Object | |
| Ogre2ScenePtr | scene |
| Pointer to the ogre scene. More... | |
| Protected Attributes inherited from BaseObject | |
| unsigned int | id |
| std::string | name |
Detailed Description
Ogre 2.x implementation of the point light class.
Constructor & Destructor Documentation
◆ Ogre2PointLight()
|
protected |
Constructor.
◆ ~Ogre2PointLight()
|
virtual |
Destructor.
The documentation for this class was generated from the following file: