All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
SurgSim::Graphics::CapsuleRepresentation Class Referenceabstract

Base graphics capsule representation class, which defines the basic interface for a capsule that can be visualized. More...

#include <SurgSim/Graphics/CapsuleRepresentation.h>

Inheritance diagram for SurgSim::Graphics::CapsuleRepresentation:
Inheritance graph
[legend]
Collaboration diagram for SurgSim::Graphics::CapsuleRepresentation:
Collaboration graph
[legend]

Public Member Functions

 CapsuleRepresentation (const std::string &name)
 Constructor. More...
 
virtual void setRadius (double radius)=0
 Sets the radius of the capsule. More...
 
virtual double getRadius () const =0
 Returns the radius of the capsule. More...
 
virtual void setHeight (double height)=0
 Sets the height of the capsulei. More...
 
virtual double getHeight () const =0
 Returns the height of the capsule. More...
 
virtual void setSize (double radius, double height)=0
 Sets the size of the capsule. More...
 
virtual void getSize (double *radius, double *height)=0
 Gets the size of the capsule. More...
 
virtual void setSize (const SurgSim::Math::Vector2d &size)=0
 Sets the size of the capsule. More...
 
virtual SurgSim::Math::Vector2d getSize () const =0
 Returns the radius of the capsule. More...
 
- Public Member Functions inherited from SurgSim::Graphics::Representation
 Representation (const std::string &name)
 Constructor. More...
 
virtual ~Representation ()
 Destructor. More...
 
virtual void setVisible (bool visible)=0
 Sets whether the representation is currently visible. More...
 
virtual bool isVisible () const =0
 Gets whether the representation is currently visible. More...
 
virtual void setLocalActive (bool val) override
 Set the component's active state. More...
 
virtual bool setMaterial (std::shared_ptr< Material > material)=0
 Sets the material that defines the visual appearance of the representation. More...
 
virtual std::shared_ptr< MaterialgetMaterial () const =0
 Gets the material that defines the visual appearance of the representation. More...
 
virtual void clearMaterial ()=0
 Removes the material from the representation. More...
 
virtual void setDrawAsWireFrame (bool val)=0
 Sets the representation to render as a wire frame. More...
 
virtual bool getDrawAsWireFrame () const =0
 Return if the representation is rendered as a wire frame. More...
 
virtual void update (double dt)=0
 Updates the representation. More...
 
virtual bool addGroupReference (const std::string &name)
 Add a reference to a group, this will eventual add this representation to the group with the the same name. More...
 
void addGroupReferences (const std::vector< std::string > &groups)
 Adds a list of group references. More...
 
void setGroupReferences (const std::vector< std::string > &groups)
 Sets the list of group references. More...
 
void setGroupReference (const std::string &group)
 Helper functions, this clears all the references and sets, only the reference given in the parameter. More...
 
std::vector< std::string > getGroupReferences ()
 Gets group references. More...
 
bool removeGroupReference (const std::string &group)
 Function to remove an unwanted reference. More...
 
void clearGroupReferences ()
 Clear all the Group references. More...
 
- Public Member Functions inherited from SurgSim::Framework::Representation
 Representation (const std::string &name)
 Constructor. More...
 
virtual void setLocalPose (const SurgSim::Math::RigidTransform3d &pose)
 Set the pose of the representation with respect to the Scene Element. More...
 
virtual
SurgSim::Math::RigidTransform3d 
getLocalPose () const
 Get the pose of the representation with respect to the Scene Element. More...
 
virtual
SurgSim::Math::RigidTransform3d 
getPose () const
 Get the pose of the representation in world coordinates. More...
 
- Public Member Functions inherited from SurgSim::Framework::Component
 Component (const std::string &name)
 Constructor. More...
 
virtual ~Component ()
 Destructor. More...
 
std::string getName () const
 Gets component name. More...
 
void setName (const std::string &name)
 Sets the name of component. More...
 
boost::uuids::uuid getUuid () const
 Gets the id of the component. More...
 
bool isInitialized () const
 
bool initialize (const std::weak_ptr< Runtime > &runtime)
 Initialize this component, this needs to be called before wakeUp() can be called. More...
 
bool isAwake () const
 
bool wakeUp ()
 Wakeup this component, this will be called when the component is inserted into the ComponentManager that is responsible for handling this component. More...
 
void setScene (std::weak_ptr< Scene > scene)
 Sets the scene. More...
 
std::shared_ptr< ScenegetScene ()
 Gets the scene. More...
 
void setSceneElement (std::weak_ptr< SceneElement > sceneElement)
 Sets the scene element. More...
 
std::shared_ptr< SceneElementgetSceneElement ()
 Gets the scene element. More...
 
std::shared_ptr< const
SceneElement
getSceneElement () const
 Gets the scene element, constant version. More...
 
std::shared_ptr< RuntimegetRuntime () const
 Get the runtime which contains this component. More...
 
virtual std::string getClassName () const
 The class name for this class, this being the base class it should return SurgSim::Framework::Component but this would make missing implemenentations of this hard to catch, therefore this calls SURGSIM_FAILURE. More...
 
std::shared_ptr< ComponentgetSharedPtr ()
 Gets a shared pointer to this component. More...
 
bool isActive () const
 
bool isLocalActive () const
 
- Public Member Functions inherited from SurgSim::Framework::Accessible
 Accessible ()
 Default Constructor. More...
 
 ~Accessible ()
 Destructor. More...
 
template<class T >
getValue (const std::string &name) const
 Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...
 
boost::any getValue (const std::string &name) const
 Retrieves the value with the name by executing the getter if it is found. More...
 
template<class T >
bool getValue (const std::string &name, T *value) const
 Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...
 
void setValue (const std::string &name, const boost::any &value)
 Sets a value of a property that has setter. More...
 
bool isReadable (const std::string &name) const
 Check whether a property is readable. More...
 
bool isWriteable (const std::string &name) const
 Check whether a property is writable. More...
 
void setGetter (const std::string &name, GetterType func)
 Sets a getter for a given property. More...
 
void setSetter (const std::string &name, SetterType func)
 Sets a setter for a given property. More...
 
void setAccessors (const std::string &name, GetterType getter, SetterType setter)
 Sets the accessors getter and setter in one function. More...
 
void removeAccessors (const std::string &name)
 Removes all the accessors (getter and setter) for a given property. More...
 
void forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
 Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...
 
void setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
 Sets the functions used to convert data from and to a YAML::Node. More...
 
YAML::Node encode () const
 Encode this Accessible to a YAML::Node. More...
 
void decode (const YAML::Node &node)
 Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...
 
template<>
boost::any getValue (const std::string &name) const
 

Additional Inherited Members

- Public Types inherited from SurgSim::Framework::Component
typedef
SurgSim::Framework::ObjectFactory1
< SurgSim::Framework::Component,
std::string > 
FactoryType
 
- Public Types inherited from SurgSim::Framework::Accessible
typedef std::function
< boost::any(void)> 
GetterType
 
typedef std::function< void(boost::any)> SetterType
 
typedef std::function
< YAML::Node(void)> 
EncoderType
 
typedef std::function< void(const
YAML::Node *)> 
DecoderType
 
- Static Public Member Functions inherited from SurgSim::Framework::Component
static FactoryTypegetFactory ()
 
- Static Public Attributes inherited from SurgSim::Graphics::Representation
static const std::string DefaultGroupName = "__OssDefault__"
 
static const std::string DefaultHudGroupName = "__OssDefaulHud__"
 
- Protected Member Functions inherited from SurgSim::Framework::Component
virtual std::shared_ptr
< PoseComponent
getPoseComponent ()
 Get the PoseComponent for this component. More...
 
virtual std::shared_ptr< const
PoseComponent
getPoseComponent () const
 Get the PoseComponent for this component, constant access. More...
 
- Protected Attributes inherited from SurgSim::Graphics::Representation
bool m_isVisible
 

Detailed Description

Base graphics capsule representation class, which defines the basic interface for a capsule that can be visualized.

The capsule center is at (0, 0, 0).

Constructor & Destructor Documentation

SurgSim::Graphics::CapsuleRepresentation::CapsuleRepresentation ( const std::string &  name)
inlineexplicit

Constructor.

Parameters
nameName of the representation
Postcondition
The capsule radius is 1.0.

Member Function Documentation

virtual double SurgSim::Graphics::CapsuleRepresentation::getHeight ( ) const
pure virtual

Returns the height of the capsule.

Returns
Height along Y-axis of the capsule

Implemented in SurgSim::Graphics::OsgCapsuleRepresentation.

virtual double SurgSim::Graphics::CapsuleRepresentation::getRadius ( ) const
pure virtual

Returns the radius of the capsule.

Returns
Radius along X-axis and Z-axis of the capsule

Implemented in SurgSim::Graphics::OsgCapsuleRepresentation.

virtual void SurgSim::Graphics::CapsuleRepresentation::getSize ( double *  radius,
double *  height 
)
pure virtual

Gets the size of the capsule.

Parameters
[out]radiusVariable to receive the size along X-axis and Z-axis of the capsule
[out]heightVariable to receive the size along Y-axis of the capsule

Implemented in SurgSim::Graphics::OsgCapsuleRepresentation.

virtual SurgSim::Math::Vector2d SurgSim::Graphics::CapsuleRepresentation::getSize ( ) const
pure virtual

Returns the radius of the capsule.

Returns
Size of the capsule

Implemented in SurgSim::Graphics::OsgCapsuleRepresentation.

virtual void SurgSim::Graphics::CapsuleRepresentation::setHeight ( double  height)
pure virtual

Sets the height of the capsulei.

Parameters
heightHeight of the capsule

Implemented in SurgSim::Graphics::OsgCapsuleRepresentation.

virtual void SurgSim::Graphics::CapsuleRepresentation::setRadius ( double  radius)
pure virtual

Sets the radius of the capsule.

Parameters
radiusRadius of the capsule

Implemented in SurgSim::Graphics::OsgCapsuleRepresentation.

virtual void SurgSim::Graphics::CapsuleRepresentation::setSize ( double  radius,
double  height 
)
pure virtual

Sets the size of the capsule.

Parameters
radiusSize along X-axis and Z-axis of the capsule
heightSize along Y-axis of the capsule

Implemented in SurgSim::Graphics::OsgCapsuleRepresentation.

virtual void SurgSim::Graphics::CapsuleRepresentation::setSize ( const SurgSim::Math::Vector2d size)
pure virtual

Sets the size of the capsule.

Parameters
sizeSize of the capsule

Implemented in SurgSim::Graphics::OsgCapsuleRepresentation.


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