DirectionalLight Class Referenceabstract
Represents a infinite directional light. More...
#include <gz/rendering/Light.hh>
Public Member Functions | |
| virtual | ~DirectionalLight () |
| Destructor. More... | |
| virtual math::Vector3d | Direction () const =0 |
| Get the direction of the light. More... | |
| virtual void | SetDirection (const math::Vector3d &_dir)=0 |
| Set the direction of the light. More... | |
| virtual void | SetDirection (double _x, double _y, double _z)=0 |
| Set the direction of the light. More... | |
 Public Member Functions inherited from Light | |
| virtual | ~Light () |
| Destructor. More... | |
| virtual double | AttenuationConstant () const =0 |
| Get the attenuation constant value. More... | |
| virtual double | AttenuationLinear () const =0 |
| Get the attenuation linear value. More... | |
| virtual double | AttenuationQuadratic () const =0 |
| Get the attenuation quadratic value. More... | |
| virtual double | AttenuationRange () const =0 |
| Get the attenuation range. More... | |
| virtual bool | CastShadows () const =0 |
| Determine if this light cast shadows. More... | |
| virtual math::Color | DiffuseColor () const =0 |
| Get the diffuse color. More... | |
| virtual double | Intensity () const =0 |
| Get the light intensity. More... | |
| virtual void | SetAttenuationConstant (double _value)=0 |
| Set the attenuation constant value. More... | |
| virtual void | SetAttenuationLinear (double _value)=0 |
| Set the attenuation linear value. More... | |
| virtual void | SetAttenuationQuadratic (double _value)=0 |
| Set the attenuation quadratic value. More... | |
| virtual void | SetAttenuationRange (double _range)=0 |
| Set the attenuation range. More... | |
| virtual void | SetCastShadows (bool _castShadows)=0 |
| Specify if this light should cast shadows. More... | |
| virtual void | SetDiffuseColor (const math::Color &_color)=0 |
| Set the diffuse color. More... | |
| virtual void | SetDiffuseColor (double _r, double _g, double _b, double _a=1.0)=0 |
| Set the diffuse color. More... | |
| virtual void | SetIntensity (double _intensity)=0 |
| Set the light intensity. More... | |
| virtual void | SetSpecularColor (const math::Color &_color)=0 |
| Set the specular color. More... | |
| virtual void | SetSpecularColor (double _r, double _g, double _b, double _a=1.0)=0 |
| Set the specular color. More... | |
| virtual math::Color | SpecularColor () const =0 |
| Get the specular color. More... | |
| Public Member Functions inherited from Node | |
| virtual | ~Node () |
| Destructor. More... | |
| virtual void | AddChild (NodePtr _child)=0 |
| 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 =0 |
| Get node with given ID. If no child exists with given ID, NULL will be returned. More... | |
| virtual NodePtr | ChildByIndex (unsigned int _index) const =0 |
| 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 =0 |
| Get node with given name. If no child exists with given name, NULL will be returned. More... | |
| virtual unsigned int | ChildCount () const =0 |
| Get number of child nodes. More... | |
| virtual bool | HasChild (ConstNodePtr _child) const =0 |
| Determine if given node is an attached child. More... | |
| virtual bool | HasChildId (unsigned int _id) const =0 |
| Determine if node with given ID is an attached child. More... | |
| virtual bool | HasChildName (const std::string &_name) const =0 |
| Determine if node with given name is an attached child. More... | |
| virtual bool | HasParent () const =0 |
| Determine if this Node is attached to another Node. More... | |
| virtual bool | HasUserData (const std::string &_key) const =0 |
| Check if node has custom data. More... | |
| virtual bool | InheritScale () const =0 |
| Determine if this node inherits scale from this parent. 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 | LocalScale () const =0 |
| Get the local scale. More... | |
| virtual math::Vector3d | Origin () const =0 |
| Get position of origin. More... | |
| virtual NodePtr | Parent () const =0 |
| Get the parent Node. More... | |
| virtual NodePtr | RemoveChild (NodePtr _child)=0 |
| 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)=0 |
| 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)=0 |
| 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)=0 |
| 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 ()=0 |
| Remove all child nodes from this node This detaches all the child nodes but does not destroy them. More... | |
| virtual void | RemoveParent ()=0 |
| 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)=0 |
| Scale the current scale by the given scalars. More... | |
| virtual void | Scale (double _scale)=0 |
| 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)=0 |
| Scale the current scale by the given scalars. More... | |
| virtual void | SetInheritScale (bool _inherit)=0 |
| Specify if this node inherits scale from its parent. More... | |
| virtual void | SetLocalPose (const math::Pose3d &_pose)=0 |
| Set the local pose. More... | |
| virtual void | SetLocalPosition (const math::Vector3d &_position)=0 |
| Set the local position. More... | |
| virtual void | SetLocalPosition (double _x, double _y, double _z)=0 |
| Set the local position. More... | |
| virtual void | SetLocalRotation (const math::Quaterniond &_rotation)=0 |
| Set the local rotation. More... | |
| virtual void | SetLocalRotation (double _r, double _p, double _y)=0 |
| Set the local rotation. More... | |
| virtual void | SetLocalRotation (double _w, double _x, double _y, double _z)=0 |
| Set the local rotation. More... | |
| virtual void | SetLocalScale (const math::Vector3d &_scale)=0 |
| Set the local scale. More... | |
| virtual void | SetLocalScale (double _scale)=0 |
| 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)=0 |
| Set the local scale. More... | |
| virtual void | SetOrigin (const math::Vector3d &_origin)=0 |
| 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)=0 |
| 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)=0 |
| Store any custom data associated with this node. More... | |
| virtual void | SetWorldPose (const math::Pose3d &_pose)=0 |
| Set the world pose. More... | |
| virtual void | SetWorldPosition (const math::Vector3d &_position)=0 |
| Set the world position. More... | |
| virtual void | SetWorldPosition (double _x, double _y, double _z)=0 |
| Set the world position. More... | |
| virtual void | SetWorldRotation (const math::Quaterniond &_rotation)=0 |
| Set the world rotation. More... | |
| virtual void | SetWorldRotation (double _r, double _p, double _y)=0 |
| Set the world rotation. More... | |
| virtual void | SetWorldRotation (double _w, double _x, double _y, double _z)=0 |
| Set the world rotation. More... | |
| virtual void | SetWorldScale (const math::Vector3d &_scale)=0 |
| Set the world scale. More... | |
| virtual void | SetWorldScale (double _scale)=0 |
| 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)=0 |
| Set the world scale. More... | |
| virtual Variant | UserData (const std::string &_key) const =0 |
| Get custom data stored in this node. 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... | |
| virtual math::Pose3d | WorldToLocal (const math::Pose3d &_pose) const =0 |
| Convert given world pose to local pose. More... | |
| Public Member Functions inherited from Object | |
| virtual | ~Object () |
| Destructor. More... | |
| virtual void | Destroy ()=0 |
| Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. 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 void | PreRender ()=0 |
| 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 ScenePtr | Scene () const =0 |
| Get the Scene that created this object. More... | |
Detailed Description
Represents a infinite directional light.
Constructor & Destructor Documentation
◆ ~DirectionalLight()
|
virtual |
Destructor.
Member Function Documentation
◆ Direction()
|
pure virtual |
Get the direction of the light.
- Returns
- The direction of the light
Implemented in Ogre2DirectionalLight, and OgreDirectionalLight.
◆ SetDirection() [1/2]
|
pure virtual |
Set the direction of the light.
- Parameters
-
[in] _dir New direction vector
Implemented in BaseDirectionalLight< T >, BaseDirectionalLight< Ogre2Light >, BaseDirectionalLight< OgreLight >, Ogre2DirectionalLight, and OgreDirectionalLight.
◆ SetDirection() [2/2]
|
pure virtual |
Set the direction of the light.
- Parameters
-
[in] _x X-component of direction vector [in] _y Y-component of direction vector [in] _z Z-component of direction vector
Implemented in BaseDirectionalLight< T >, BaseDirectionalLight< Ogre2Light >, and BaseDirectionalLight< OgreLight >.
The documentation for this class was generated from the following file: