Public Member Functions | List of all members
SurgSim::Math::DoubleSidedPlaneShape Class Reference

DoubleSidedPlaneShape: The XZ plane (d = 0) with normal pointing along positive Y axis. More...

#include <SurgSim/Math/DoubleSidedPlaneShape.h>

Inheritance diagram for SurgSim::Math::DoubleSidedPlaneShape:
SurgSim::Math::Shape SurgSim::Framework::Accessible

Public Member Functions

 DoubleSidedPlaneShape ()
 Constructor. More...
 
 SURGSIM_CLASSNAME (SurgSim::Math::DoubleSidedPlaneShape)
 
virtual int getType () override
 
virtual double getVolume () const override
 Get the volume of the shape. More...
 
virtual Vector3d getCenter () const override
 Get the volumetric center of the shape. More...
 
virtual Matrix33d getSecondMomentOfVolume () const override
 Get the second central moment of the volume, commonly used to calculate the moment of inertia matrix. More...
 
double getD () const
 Gets the d of the plane equation. More...
 
Vector3d getNormal () const
 Gets the normal of the plane equation. More...
 
virtual bool isValid () const override
 A DoubleSidedPlaneShape is always valid. More...
 
- Public Member Functions inherited from SurgSim::Math::Shape
virtual ~Shape ()
 
virtual std::string getClassName () const
 Get class name. More...
 
- 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, const std::vector< std::string > &ignoredProperties=std::vector< std::string >())
 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::Math::Shape
typedef ::SurgSim::Math::Vector3d Vector3d
 
typedef ::SurgSim::Math::Matrix33d Matrix33d
 
typedef SurgSim::Framework::ObjectFactory< SurgSim::Math::ShapeFactoryType
 
- 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::Math::Shape
static FactoryTypegetFactory ()
 

Detailed Description

DoubleSidedPlaneShape: The XZ plane (d = 0) with normal pointing along positive Y axis.

Constructor & Destructor Documentation

SurgSim::Math::DoubleSidedPlaneShape::DoubleSidedPlaneShape ( )

Constructor.

Member Function Documentation

SurgSim::Math::Vector3d SurgSim::Math::DoubleSidedPlaneShape::getCenter ( ) const
overridevirtual

Get the volumetric center of the shape.

Returns
The center of the shape

Implements SurgSim::Math::Shape.

double SurgSim::Math::DoubleSidedPlaneShape::getD ( ) const

Gets the d of the plane equation.

Returns
The value of d (always 0).
SurgSim::Math::Vector3d SurgSim::Math::DoubleSidedPlaneShape::getNormal ( ) const

Gets the normal of the plane equation.

Returns
The value of the normal (always Y axis).
SurgSim::Math::Matrix33d SurgSim::Math::DoubleSidedPlaneShape::getSecondMomentOfVolume ( ) const
overridevirtual

Get the second central moment of the volume, commonly used to calculate the moment of inertia matrix.

Returns
The 3x3 symmetric second moment matrix

Implements SurgSim::Math::Shape.

int SurgSim::Math::DoubleSidedPlaneShape::getType ( )
overridevirtual
Returns
the type of the shape

Implements SurgSim::Math::Shape.

double SurgSim::Math::DoubleSidedPlaneShape::getVolume ( ) const
overridevirtual

Get the volume of the shape.

Returns
The volume of the shape (in m-3)

Implements SurgSim::Math::Shape.

bool SurgSim::Math::DoubleSidedPlaneShape::isValid ( ) const
overridevirtual

A DoubleSidedPlaneShape is always valid.

Returns
True.

Implements SurgSim::Math::Shape.

SurgSim::Math::DoubleSidedPlaneShape::SURGSIM_CLASSNAME ( SurgSim::Math::DoubleSidedPlaneShape  )

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