DART  6.6.2
dart::dynamics::CollisionAspect Class Referencefinal

#include <ShapeFrame.hpp>

Inheritance diagram for dart::dynamics::CollisionAspect:
dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >

Public Types

using Base = BaseT
 
using Derived = DerivedT
 
using PropertiesData = PropertiesDataT
 
using CompositeType = CompositeT
 
using Properties = Aspect::MakeProperties< PropertiesData >
 
using AspectImplementation = AspectWithVersionedProperties< Base, Derived, PropertiesData, CompositeT, updateProperties >
 

Public Member Functions

 CollisionAspect (const CollisionAspect &)=delete
 
 CollisionAspect (const PropertiesData &properties=PropertiesData())
 
void setCollidable (const bool &value)
 
const bool & getCollidable () const
 
bool isCollidable () const
 Return true if this body can collide with others bodies. More...
 
void setAspectProperties (const Aspect::Properties &someProperties) override final
 
const Aspect::Properties * getAspectProperties () const override final
 
void setProperties (const PropertiesData &properties)
 Set the Properties of this Aspect. More...
 
const PropertiesgetProperties () const
 Get the Properties of this Aspect. More...
 
std::unique_ptr< Aspect > cloneAspect () const override
 
std::size_t incrementVersion ()
 Increment the version of this Aspect and its Composite. More...
 
void notifyPropertiesUpdate ()
 Call UpdateProperties(this) and incrementVersion() More...
 
void notifyPropertiesUpdated ()
 Call UpdateProperties(this) and incrementVersion() More...
 

Static Public Attributes

constexpr static void(* UpdateProperties )(Derived *) = updateProperties
 

Protected Attributes

Properties mProperties
 Properties of this Aspect. More...
 

Member Typedef Documentation

◆ AspectImplementation

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::AspectImplementation = AspectWithVersionedProperties< Base, Derived, PropertiesData, CompositeT, updateProperties>
inherited

◆ Base

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::Base = BaseT
inherited

◆ CompositeType

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::CompositeType = CompositeT
inherited

◆ Derived

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::Derived = DerivedT
inherited

◆ Properties

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::Properties = Aspect::MakeProperties<PropertiesData>
inherited

◆ PropertiesData

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
using dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::PropertiesData = PropertiesDataT
inherited

Constructor & Destructor Documentation

◆ CollisionAspect() [1/2]

dart::dynamics::CollisionAspect::CollisionAspect ( const CollisionAspect )
delete

◆ CollisionAspect() [2/2]

dart::dynamics::CollisionAspect::CollisionAspect ( const PropertiesData properties = PropertiesData())

Member Function Documentation

◆ cloneAspect()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
std::unique_ptr< Aspect > dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::cloneAspect
overrideinherited

◆ getAspectProperties()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
const Aspect::Properties * dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::getAspectProperties
finaloverrideinherited

◆ getCollidable()

const bool& dart::dynamics::CollisionAspect::getCollidable ( ) const
inline

◆ getProperties()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
auto dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::getProperties
inherited

Get the Properties of this Aspect.

◆ incrementVersion()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
std::size_t dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::incrementVersion
inherited

Increment the version of this Aspect and its Composite.

◆ isCollidable()

bool dart::dynamics::CollisionAspect::isCollidable ( ) const

Return true if this body can collide with others bodies.

◆ notifyPropertiesUpdate()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
void dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::notifyPropertiesUpdate
inherited

Call UpdateProperties(this) and incrementVersion()

◆ notifyPropertiesUpdated()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
void dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::notifyPropertiesUpdated
inherited

Call UpdateProperties(this) and incrementVersion()

◆ setAspectProperties()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
void dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::setAspectProperties ( const Aspect::Properties someProperties)
finaloverrideinherited

◆ setCollidable()

void dart::dynamics::CollisionAspect::setCollidable ( const bool &  value)
inline

◆ setProperties()

template<class BaseT , class DerivedT , typename PropertiesData , class CompositeT , void(*)(DerivedT *) updateProperties>
void dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesData, CompositeT, updateProperties >::setProperties ( const PropertiesData properties)
inherited

Set the Properties of this Aspect.

Member Data Documentation

◆ mProperties

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
Properties dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::mProperties
protectedinherited

Properties of this Aspect.

◆ UpdateProperties

template<class BaseT , class DerivedT , typename PropertiesDataT , class CompositeT = Composite, void(*)(DerivedT *) updateProperties = &NoOp<DerivedT*>>
constexpr static void(* dart::common::detail::AspectWithVersionedProperties< BaseT, DerivedT, PropertiesDataT, CompositeT, updateProperties >::UpdateProperties) (Derived *) = updateProperties
staticconstexprinherited