DART  6.10.1
dart::dynamics::Shape Class Referenceabstract

#include <Shape.hpp>

Inheritance diagram for dart::dynamics::Shape:
dart::common::Subject dart::common::VersionCounter dart::dynamics::HeightmapShape< S > dart::dynamics::BoxShape dart::dynamics::CapsuleShape dart::dynamics::ConeShape dart::dynamics::CylinderShape dart::dynamics::EllipsoidShape dart::dynamics::HeightmapShape< S_ > dart::dynamics::LineSegmentShape dart::dynamics::MeshShape dart::dynamics::MultiSphereConvexHullShape dart::dynamics::PlaneShape dart::dynamics::PointCloudShape dart::dynamics::PyramidShape dart::dynamics::SoftMeshShape dart::dynamics::SphereShape

Public Types

enum  ShapeType {
  SPHERE , BOX , ELLIPSOID , CYLINDER ,
  CAPSULE , CONE , PYRAMID , RECTANGULAR_PYRAMID ,
  PLANE , MULTISPHERE , MESH , SOFT_MESH ,
  LINE_SEGMENT , HEIGHTMAP , UNSUPPORTED
}
 
enum  DataVariance {
  STATIC = 0 , DYNAMIC_TRANSFORM = 1 << 1 , DYNAMIC_PRIMITIVE = 1 << 2 , DYNAMIC_COLOR = 1 << 3 ,
  DYNAMIC_VERTICES = 1 << 4 , DYNAMIC_ELEMENTS = 1 << 5 , DYNAMIC = 0xFF
}
 DataVariance can be used by renderers to determine whether it should expect data for this shape to change during each update. More...
 
using VersionChangedSignal = common::Signal< void(Shape *shape, std::size_t version)>
 

Public Member Functions

 Shape (ShapeType _type)
 Constructor. More...
 
 Shape ()
 Constructor. More...
 
virtual ~Shape ()
 Destructor. More...
 
virtual const std::string & getType () const =0
 Returns a string representing the shape type. More...
 
template<typename ShapeT >
bool is () const
 Get true if the types of this Shape and the template parameter (a shape class) are identical. More...
 
const math::BoundingBoxgetBoundingBox () const
 Get the bounding box of the shape in its local coordinate frame. More...
 
virtual Eigen::Matrix3d computeInertia (double mass) const =0
 Computes the inertia. More...
 
Eigen::Matrix3d computeInertiaFromDensity (double density) const
 
Eigen::Matrix3d computeInertiaFromMass (double mass) const
 
double getVolume () const
 Returns volume of this shape. More...
 
std::size_t getID () const
 
ShapeType getShapeType () const
 
void setDataVariance (unsigned int _variance)
 Set the data variance of this shape. More...
 
void addDataVariance (unsigned int _variance)
 Add a type of variance to this shape. More...
 
void removeDataVariance (unsigned int _variance)
 Remove a type of variance from this shape. More...
 
unsigned int getDataVariance () const
 Get the data variance of this shape. More...
 
bool checkDataVariance (DataVariance type) const
 True iff this Shape has the specified type of DataVariance. More...
 
virtual void refreshData ()
 Instruct this shape to update its data. More...
 
virtual void notifyAlphaUpdate (double alpha)
 Notify that the alpha of this shape has updated. More...
 
virtual void notifyAlphaUpdated (double alpha)
 Notify that the alpha of this shape has updated. More...
 
virtual void notifyColorUpdate (const Eigen::Vector4d &color)
 Notify that the color (rgba) of this shape has updated. More...
 
virtual void notifyColorUpdated (const Eigen::Vector4d &color)
 Notify that the color (rgba) of this shape has updated. More...
 
std::size_t incrementVersion () override final
 Increment the version of this Shape and notify its subscribers. More...
 
virtual std::size_t getVersion () const
 Get the version number of this object. More...
 

Public Attributes

common::SlotRegister< VersionChangedSignalonVersionChanged
 Use this to subscribe to version change signals. More...
 

Protected Member Functions

virtual void updateVolume () const =0
 Updates volume. More...
 
virtual void updateBoundingBox () const =0
 Updates bounding box. More...
 
void sendDestructionNotification () const
 Send a destruction notification to all Observers. More...
 
void addObserver (Observer *_observer) const
 Add an Observer to the list of Observers. More...
 
void removeObserver (Observer *_observer) const
 Remove an Observer from the list of Observers. More...
 
void setVersionDependentObject (VersionCounter *dependent)
 

Protected Attributes

math::BoundingBox mBoundingBox
 The bounding box (in the local coordinate frame) of the shape. More...
 
bool mIsBoundingBoxDirty
 Whether bounding box needs update. More...
 
double mVolume
 Volume enclosed by the geometry. More...
 
bool mIsVolumeDirty
 Whether volume needs update. More...
 
const std::size_t mID
 Unique id. More...
 
unsigned int mVariance
 The DataVariance of this Shape. More...
 
ShapeType mType
 
std::set< Observer * > mObservers
 List of current Observers. More...
 
std::size_t mVersion
 

Static Protected Attributes

static std::atomic_int mCounter { 1000 }
 

Private Attributes

VersionChangedSignal mVersionChangedSignal
 Triggered by incrementVersion() More...
 
VersionCountermDependent
 

Member Typedef Documentation

◆ VersionChangedSignal

using dart::dynamics::Shape::VersionChangedSignal = common::Signal<void(Shape* shape, std::size_t version)>

Member Enumeration Documentation

◆ DataVariance

DataVariance can be used by renderers to determine whether it should expect data for this shape to change during each update.

Enumerator
STATIC 
DYNAMIC_TRANSFORM 

No data will ever change.

DYNAMIC_PRIMITIVE 

The relative transform of the Shape might change.

DYNAMIC_COLOR 

The primitive properties (such as x/y/z scaling) of the shape might change.

DYNAMIC_VERTICES 

The coloring or textures of the shape might change.

DYNAMIC_ELEMENTS 

Vertex positions of a mesh might change (this does not include adding or removing vertices) (this enum is not relevant for primitive shapes)

DYNAMIC 

The number of elements and/or arrangement of elements might change (this includes adding and removing vertices) (this enum is not relevant for primitive shapes)

◆ ShapeType

Deprecated:
Deprecated in 6.1. Please use getType() instead.
Enumerator
SPHERE 
BOX 
ELLIPSOID 
CYLINDER 
CAPSULE 
CONE 
PYRAMID 
RECTANGULAR_PYRAMID 
PLANE 
MULTISPHERE 
MESH 
SOFT_MESH 
LINE_SEGMENT 
HEIGHTMAP 
UNSUPPORTED 

Constructor & Destructor Documentation

◆ Shape() [1/2]

dart::dynamics::Shape::Shape ( ShapeType  _type)
explicit

Constructor.

Deprecated:
Deprecated in 6.1.

Please use getType() instead.

◆ Shape() [2/2]

dart::dynamics::Shape::Shape ( )

Constructor.

◆ ~Shape()

dart::dynamics::Shape::~Shape ( )
virtual

Destructor.

Member Function Documentation

◆ addDataVariance()

void dart::dynamics::Shape::addDataVariance ( unsigned int  _variance)

Add a type of variance to this shape.

All other variance types will remain the same.

◆ addObserver()

void dart::common::Subject::addObserver ( Observer _observer) const
protectedinherited

Add an Observer to the list of Observers.

◆ checkDataVariance()

bool dart::dynamics::Shape::checkDataVariance ( DataVariance  type) const

True iff this Shape has the specified type of DataVariance.

◆ computeInertia()

◆ computeInertiaFromDensity()

Eigen::Matrix3d dart::dynamics::Shape::computeInertiaFromDensity ( double  density) const

◆ computeInertiaFromMass()

Eigen::Matrix3d dart::dynamics::Shape::computeInertiaFromMass ( double  mass) const

◆ getBoundingBox()

const math::BoundingBox & dart::dynamics::Shape::getBoundingBox ( ) const

Get the bounding box of the shape in its local coordinate frame.

The dimension will be automatically determined by the sub-classes such as BoxShape, EllipsoidShape, CylinderShape, and MeshShape.

◆ getDataVariance()

unsigned int dart::dynamics::Shape::getDataVariance ( ) const

Get the data variance of this shape.

◆ getID()

std::size_t dart::dynamics::Shape::getID ( ) const

◆ getShapeType()

Shape::ShapeType dart::dynamics::Shape::getShapeType ( ) const
Deprecated:
Deprecated in 6.1. Please use getType() instead.

◆ getType()

◆ getVersion()

std::size_t dart::common::VersionCounter::getVersion ( ) const
virtualinherited

Get the version number of this object.

◆ getVolume()

double dart::dynamics::Shape::getVolume ( ) const

Returns volume of this shape.

The volume will be automatically calculated by the sub-classes such as BoxShape, EllipsoidShape, CylinderShape, and MeshShape.

◆ incrementVersion()

std::size_t dart::dynamics::Shape::incrementVersion ( )
finaloverridevirtual

Increment the version of this Shape and notify its subscribers.

Reimplemented from dart::common::VersionCounter.

◆ is()

template<typename ShapeT >
bool dart::dynamics::Shape::is

Get true if the types of this Shape and the template parameter (a shape class) are identical.

This function is a syntactic sugar, which is identical to: (getType() == ShapeType::getStaticType()).

Example code:

auto shape = bodyNode->getShapeNode(0)->getShape();
if (shape->is<BoxShape>())
std::cout << "The shape type is box!\n";
See also
getType()

◆ notifyAlphaUpdate()

void dart::dynamics::Shape::notifyAlphaUpdate ( double  alpha)
virtual

Notify that the alpha of this shape has updated.

◆ notifyAlphaUpdated()

void dart::dynamics::Shape::notifyAlphaUpdated ( double  alpha)
virtual

Notify that the alpha of this shape has updated.

◆ notifyColorUpdate()

void dart::dynamics::Shape::notifyColorUpdate ( const Eigen::Vector4d &  color)
virtual

Notify that the color (rgba) of this shape has updated.

◆ notifyColorUpdated()

void dart::dynamics::Shape::notifyColorUpdated ( const Eigen::Vector4d &  color)
virtual

Notify that the color (rgba) of this shape has updated.

Reimplemented in dart::dynamics::PointCloudShape, dart::dynamics::HeightmapShape< S_ >, dart::dynamics::HeightmapShape< S >, and dart::dynamics::ArrowShape.

◆ refreshData()

void dart::dynamics::Shape::refreshData ( )
virtual

Instruct this shape to update its data.

◆ removeDataVariance()

void dart::dynamics::Shape::removeDataVariance ( unsigned int  _variance)

Remove a type of variance from this shape.

All other variance types will remain the same.

◆ removeObserver()

void dart::common::Subject::removeObserver ( Observer _observer) const
protectedinherited

Remove an Observer from the list of Observers.

◆ sendDestructionNotification()

void dart::common::Subject::sendDestructionNotification ( ) const
protectedinherited

Send a destruction notification to all Observers.

This will cause all Observers to behave as if this Subject has been permanently deleted, so it should only be called when that behavior is desired.

◆ setDataVariance()

void dart::dynamics::Shape::setDataVariance ( unsigned int  _variance)

Set the data variance of this shape.

Use the DataVariance to indicate what kind of shape information might change during run time so that renderers can optimize reliably.

◆ setVersionDependentObject()

void dart::common::VersionCounter::setVersionDependentObject ( VersionCounter dependent)
protectedinherited

◆ updateBoundingBox()

◆ updateVolume()

Member Data Documentation

◆ mBoundingBox

math::BoundingBox dart::dynamics::Shape::mBoundingBox
mutableprotected

The bounding box (in the local coordinate frame) of the shape.

◆ mCounter

std::atomic_int dart::dynamics::Shape::mCounter { 1000 }
staticprotected

◆ mDependent

VersionCounter* dart::common::VersionCounter::mDependent
privateinherited

◆ mID

const std::size_t dart::dynamics::Shape::mID
protected

Unique id.

◆ mIsBoundingBoxDirty

bool dart::dynamics::Shape::mIsBoundingBoxDirty
mutableprotected

Whether bounding box needs update.

◆ mIsVolumeDirty

bool dart::dynamics::Shape::mIsVolumeDirty
mutableprotected

Whether volume needs update.

◆ mObservers

std::set<Observer*> dart::common::Subject::mObservers
mutableprotectedinherited

List of current Observers.

◆ mType

ShapeType dart::dynamics::Shape::mType
protected
Deprecated:
Deprecated in 6.1.

Please use getType() instead. Type of primitive shpae.

◆ mVariance

unsigned int dart::dynamics::Shape::mVariance
protected

The DataVariance of this Shape.

◆ mVersion

std::size_t dart::common::VersionCounter::mVersion
protectedinherited

◆ mVersionChangedSignal

VersionChangedSignal dart::dynamics::Shape::mVersionChangedSignal
private

Triggered by incrementVersion()

◆ mVolume

double dart::dynamics::Shape::mVolume
mutableprotected

Volume enclosed by the geometry.

◆ onVersionChanged

common::SlotRegister<VersionChangedSignal> dart::dynamics::Shape::onVersionChanged

Use this to subscribe to version change signals.