OgreArrowVisual Class Reference

#include <OgreArrowVisual.hh>

Public Member Functions
virtual	~OgreArrowVisual ()
Public Member Functions inherited from BaseArrowVisual< OgreVisual >
virtual	~BaseArrowVisual ()
virtual VisualPtr	Head () const
	Get arrow-head visual. More...
virtual VisualPtr	Shaft () const
	Get arrow-shaft visual. More...
Public Member Functions inherited from ArrowVisual
virtual	~ArrowVisual ()
	Deconstructor. More...
Public Member Functions inherited from CompositeVisual
virtual	~CompositeVisual ()
	Deconstructor. More...
Public Member Functions inherited from Visual
virtual	~Visual ()
	Deconstructor. More...
Public Member Functions inherited from Node
virtual	~Node ()
	Deconstructor. More...
Public Member Functions inherited from Object
virtual	~Object ()
	Deconstructor. More...
Public Member Functions inherited from OgreVisual
virtual	~OgreVisual ()
virtual bool	InheritScale () const
	Determine if this visual inherits scale from this parent. More...
virtual math::Vector3d	LocalScale () const
	Get the local scale. More...
virtual void	SetInheritScale (bool _inherit)
	Specify if this visual inherits scale from its parent. More...
Public Member Functions inherited from BaseVisual< OgreNode >
virtual	~BaseVisual ()
virtual void	AddChild (NodePtr _child)
	Add the given node to this visual. If the given node is already a child, no work will be done. More...
virtual void	AddGeometry (GeometryPtr _geometry)
	Add the given geometry to this visual. If the given node is already attached, no work will be done. More...
virtual NodePtr	ChildById (unsigned int _id) const
	Get node with given ID. If no child exists with given ID, NULL will be returned. More...
virtual NodePtr	ChildByIndex (unsigned int _index) const
	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
	Get node with given name. If no child exists with given name, NULL will be returned. More...
virtual unsigned int	ChildCount () const
	Get number of child nodes. More...
virtual void	Destroy ()
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
virtual GeometryPtr	GeometryByIndex (unsigned int _index) const
	Get geometry at given index. If no geometry exists at given index, NULL will be returned. More...
virtual unsigned int	GeometryCount () const
	Get the number of geometries attached to this visual. More...
virtual bool	HasChild (ConstNodePtr _child) const
	Determine if given node is an attached child. More...
virtual bool	HasChildId (unsigned int _id) const
	Determine if node with given ID is an attached child. More...
virtual bool	HasChildName (const std::string &_name) const
	Determine if node with given name is an attached child. More...
virtual bool	HasGeometry (ConstGeometryPtr _geometry) const
	Determine if given geometry is attached to this visual. More...
virtual math::Pose3d	LocalPose () const
	Get the local pose. More...
virtual MaterialPtr	Material ()
	Get the material assigned to attached visuals and geometries. More...
virtual void	PreRender ()
	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)
	Remove the given node from this visual. If the given node is not a child of this visual, no work will be done. More...
virtual NodePtr	RemoveChildById (unsigned int _id)
	Remove the node with the given ID from this visual. If the specified node is not a child of this visual, no work will be done. More...
virtual NodePtr	RemoveChildByIndex (unsigned int _index)
	Remove the node at the given index from this visual. If the specified node is not a child of this visual, no work will be done. More...
virtual NodePtr	RemoveChildByName (const std::string &_name)
	Remove the node with the given name from this visual. If the specified node is not a child of this visual, no work will be done. More...
virtual void	RemoveChildren ()
	Remove all child nodes from this visual. More...
virtual void	RemoveGeometries ()
	Remove all attached geometries from this visual. More...
virtual GeometryPtr	RemoveGeometry (GeometryPtr _geometry)
	Remove the given geometry from this visual. If the given node is not a child of this visual, no work will be done. More...
virtual GeometryPtr	RemoveGeometryByIndex (unsigned int _index)
	Remove the geometry at the given index from this visual. If the specified node is not attached this visual, no work will be done. More...
virtual void	Scale (double _scale)
	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)
	Scale the current scale by the given scalars. More...
virtual void	Scale (const math::Vector3d &_scale)
	Scale the current scale by the given scalars. More...
virtual void	SetChildMaterial (MaterialPtr _material, bool _unique=true)
	Set the material for all attached visuals only. More...
virtual void	SetGeometryMaterial (MaterialPtr _material, bool _unique=true)
	Set the material for all attached geometries only. More...
virtual void	SetLocalPose (const math::Pose3d &_pose)
	Set the local pose. More...
virtual void	SetLocalScale (double _scale)
	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)
	Set the local scale. More...
virtual void	SetLocalScale (const math::Vector3d &_scale)
	Set the local scale. More...
virtual void	SetMaterial (const std::string &_name, bool _unique=true)
	Set the material for all attached visuals and geometries. The specified material will be retrieved from Scene::Material using the given material name. If no material is registered with the given name, no work will be done. More...
virtual void	SetMaterial (MaterialPtr _material, bool _unique=true)
	Set the material for all attached visuals and geometries. More...
virtual void	SetWorldScale (double _scale)
	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)
	Set the world scale. More...
virtual void	SetWorldScale (const math::Vector3d &_scale)
	Set the world scale. More...
virtual math::Vector3d	WorldScale () const
	Get the world scale. More...
Public Member Functions inherited from OgreNode
virtual	~OgreNode ()
virtual bool	HasParent () const
	Determine if this Geometry is attached to a Visual. More...
virtual Ogre::SceneNode *	Node () const
virtual VisualPtr	Parent () const
	Get the parent Visual. More...
Public Member Functions inherited from BaseNode< OgreObject >
virtual	~BaseNode ()
virtual math::Vector3d	LocalPosition () const
	Get the local position. More...
virtual math::Quaterniond	LocalRotation () const
	Get the local rotation. More...
virtual math::Vector3d	Origin () const
	Get position of origin. More...
virtual void	RemoveParent ()
	Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More...
virtual void	SetLocalPosition (double _x, double _y, double _z)
	Set the local position. More...
virtual void	SetLocalPosition (const math::Vector3d &_position)
	Set the local position. More...
virtual void	SetLocalRotation (double _r, double _p, double _y)
	Set the local rotation. More...
virtual void	SetLocalRotation (double _w, double _x, double _y, double _z)
	Set the local rotation. More...
virtual void	SetLocalRotation (const math::Quaterniond &_rotation)
	Set the local rotation. More...
virtual void	SetOrigin (double _x, double _y, double _z)
	Set position of origin. The position should be relative to the original origin of the geometry. More...
virtual void	SetOrigin (const math::Vector3d &_origin)
	Set position of origin. The position should be relative to the original origin of the geometry. More...
virtual void	SetWorldPose (const math::Pose3d &_pose)
	Set the world pose. More...
virtual void	SetWorldPosition (double _x, double _y, double _z)
	Set the world position. More...
virtual void	SetWorldPosition (const math::Vector3d &_position)
	Set the world position. More...
virtual void	SetWorldRotation (double _r, double _p, double _y)
	Set the world rotation. More...
virtual void	SetWorldRotation (double _w, double _x, double _y, double _z)
	Set the world rotation. More...
virtual void	SetWorldRotation (const math::Quaterniond &_rotation)
	Set the world rotation. More...
virtual math::Pose3d	WorldPose () const
	Get the world pose. More...
virtual math::Vector3d	WorldPosition () const
	Get the world position. More...
virtual math::Quaterniond	WorldRotation () const
	Get the world rotation. More...
virtual math::Pose3d	WorldToLocal (const math::Pose3d &_pose) const
	Convert given world pose to local pose. More...
Public Member Functions inherited from OgreObject
virtual	~OgreObject ()
virtual ScenePtr	Scene () const
	Get the Scene that created this object. More...
Public Member Functions inherited from BaseObject
virtual	~BaseObject ()
virtual unsigned int	Id () const
	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
	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...
Public Member Functions inherited from enable_shared_from_this< BaseObject >
T	enable_shared_from_this (T... args)
T	~enable_shared_from_this (T... args)
T	operator= (T... args)
T	shared_from_this (T... args)

Protected Member Functions
	OgreArrowVisual ()
Protected Member Functions inherited from BaseArrowVisual< OgreVisual >
	BaseArrowVisual ()
virtual void	Init ()
Protected Member Functions inherited from OgreVisual
	OgreVisual ()
virtual bool	AttachChild (NodePtr _child)
virtual bool	AttachGeometry (GeometryPtr _geometry)
virtual NodeStorePtr	Children () const
virtual bool	DetachChild (NodePtr _child)
virtual bool	DetachGeometry (GeometryPtr _geometry)
virtual GeometryStorePtr	Geometries () const
virtual void	SetLocalScaleImpl (const math::Vector3d &_scale)
Protected Member Functions inherited from BaseVisual< OgreNode >
	BaseVisual ()
virtual void	PreRenderChildren ()
virtual void	PreRenderGeometries ()
Protected Member Functions inherited from OgreNode
	OgreNode ()
virtual void	Load ()
virtual math::Pose3d	RawLocalPose () const
virtual math::Vector3d	RawLocalPosition () const
virtual math::Quaterniond	RawLocalRotation () const
virtual void	SetParent (OgreVisualPtr _parent)
virtual void	SetRawLocalPose (const math::Pose3d &_Pose3d)
virtual void	SetRawLocalPosition (const math::Vector3d &_position)
virtual void	SetRawLocalRotation (const math::Quaterniond &_rotation)
Protected Member Functions inherited from BaseNode< OgreObject >
	BaseNode ()
Protected Member Functions inherited from OgreObject
	OgreObject ()
Protected Member Functions inherited from BaseObject
	BaseObject ()

Additional Inherited Members
Protected Attributes inherited from OgreVisual
OgreNodeStorePtr	children
OgreGeometryStorePtr	geometries
Protected Attributes inherited from BaseVisual< OgreNode >
MaterialPtr	material
	Pointer to material assigned to this visual. More...
Protected Attributes inherited from OgreNode
Ogre::SceneNode *	ogreNode
OgreVisualPtr	parent
Protected Attributes inherited from BaseNode< OgreObject >
math::Vector3d	origin
Protected Attributes inherited from OgreObject
OgreScenePtr	scene
Protected Attributes inherited from BaseObject
unsigned int	id
std::string	name

Constructor & Destructor Documentation

OgreArrowVisual()

OgreArrowVisual ( )

protected

~OgreArrowVisual()

virtual ~OgreArrowVisual ( )

virtual

---

The documentation for this class was generated from the following file:

• OgreArrowVisual.hh