Visual Class Reference

A renderable object. More...

#include <Visual.hh>

Inheritance diagram for Visual:

List of all members.

Public Member Functions
	Visual (const std::string &name, VisualPtr _parent)
	Constructor.
	Visual (const std::string &name, Scene *scene)
	Constructor.
virtual	~Visual ()
	Destructor.
void	Init ()
	Helper for the contructor.
void	Fini ()
void	LoadFromMsg (const boost::shared_ptr< msgs::Visual const > &msg)
	Load from a message.
void	Load (sdf::ElementPtr &sdf)
	Load the visual with a set of parameters.
void	Load ()
	Load the visual with default parameters.
void	Update ()
	Update the visual.
void	SetName (const std::string &name)
	Set the name of the visual.
std::string	GetName () const
	Get the name of the visual.
void	AttachVisual (VisualPtr _vis)
	Attach a visual.
void	DetachVisual (VisualPtr _vis)
	Detach a visual.
void	DetachVisual (const std::string &_name)
void	AttachObject (Ogre::MovableObject *obj)
	Attach a renerable object to the visual.
void	DetachObjects ()
	Detach all objects.
unsigned int	GetChildCount ()
	Get the number of attached visuals.
VisualPtr	GetChild (unsigned int _num)
	Get an attached visual.
void	AttachMesh (const std::string &meshName)
	Attach a mesh to this visual by name.
void	SetScale (const math::Vector3 &scale)
	Set the scale.
math::Vector3	GetScale ()
	Get the scale.
void	SetMaterial (const std::string &materialName)
	Set the material.
void	SetAmbient (const common::Color &_color)
	Set the ambient color of the visual.
void	SetDiffuse (const common::Color &_color)
	Set the diffuse color of the visual.
void	SetSpecular (const common::Color &_color)
	Set the specular color of the visual.
void	AttachAxes ()
void	SetTransparency (float trans)
	Set the transparency.
float	GetTransparency ()
	Get the transparency.
void	SetEmissive (const common::Color &_color)
	Set the emissive value.
void	SetCastShadows (const bool &shadows)
	Set whether the visual should cast shadows.
void	SetVisible (bool visible, bool cascade=true)
	Set whether the visual is visible.
void	ToggleVisible ()
	Toggle whether this visual is visible.
bool	GetVisible () const
	Get whether the visual is visible.
void	SetPosition (const math::Vector3 &pos)
	Set the position of the visual.
void	SetRotation (const math::Quaternion &rot)
	Set the rotation of the visual.
void	SetPose (const math::Pose &pose)
	Set the pose of the visual.
math::Vector3	GetPosition () const
	Get the position of the visual.
math::Quaternion	GetRotation () const
	Get the rotation of the visual.
math::Pose	GetPose () const
	Get the pose of the visual.
math::Pose	GetWorldPose () const
	Get the global pose of the node.
void	SetWorldPose (const math::Pose _pose)
	Set the world pose of the visual.
void	SetWorldPosition (const math::Vector3 &_pos)
void	SetWorldRotation (const math::Quaternion &_q)
Ogre::SceneNode *	GetSceneNode () const
	Return the scene Node of this visual entity.
void	MakeStatic ()
	Make the visual objects static renderables.
bool	IsStatic () const
	Return true if the visual is a static geometry.
void	EnableTrackVisual (Visual *vis)
	Set one visual to track/follow another.
void	DisableTrackVisual ()
	Disable tracking of a visual.
std::string	GetNormalMap () const
	Get the normal map.
void	SetNormalMap (const std::string &nmap)
	Set the normal map.
void	SetRibbonTrail (bool value)
	True on or off a ribbon trail.
math::Box	GetBoundingBox () const
	Get the bounding box for the visual.
DynamicLines *	CreateDynamicLine (RenderOpType type=RENDERING_LINE_STRIP)
	Add a line to the visual.
void	DeleteDynamicLine (DynamicLines *line)
	Delete a dynamic line.
void	AttachLineVertex (DynamicLines *_line, unsigned int _index)
	Attach a vertex of a line to the position of the visual.
std::string	GetMaterialName () const
	Get the name of the material.
void	UpdateFromMsg (const boost::shared_ptr< msgs::Visual const > &msg)
	Update a visual based on a message.
bool	IsPlane () const
	Return true if the visual is a plane.
VisualPtr	GetParent () const
	Get the parent visual, if one exists.
std::string	GetShaderType () const
	Get the shader type.
void	SetShaderType (const std::string &_type)
	Set the shader type.
void	MoveToPosition (const math::Vector3 &_end, double _pitch, double _yaw, double _time)
void	ShowBoundingBox ()
void	ShowCollision (bool _show)
void	SetScene (Scene *_scene)
Scene *	GetScene () const
void	ClearParent ()
Static Public Member Functions
static void	InsertMesh (const common::Mesh *mesh)
	Insert a mesh into Ogre.
Public Attributes
VisualPtr	parent
std::vector< VisualPtr >	children
Protected Attributes
Ogre::SceneNode *	sceneNode
std::vector< common::Param * >	parameters
	List of all the parameters.
Scene *	scene

---

Detailed Description

A renderable object.

---

Member Function Documentation

void SetVisible	(	bool	visible,
		bool	cascade = true
	)

Set whether the visual is visible.

Parameters:

visible	set this node visible
cascade	setting this parameter in children too

---

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

• Visual.hh