dart::dynamics::TemplateBodyNodePtr< BodyNodeT > Class Template Reference

TemplateBodyNodePtr is a templated class that enables users to create a reference-counting BodyNodePtr. More...

#include <BodyNodePtr.hpp>

Public Member Functions
	TemplateBodyNodePtr ()
	Default constructor.
	TemplateBodyNodePtr (BodyNodeT *_ptr)
	Typical constructor. More...
	TemplateBodyNodePtr (const TemplateBodyNodePtr &_bnp)
	User defined copy-constructor.
template<class OtherBodyNodeT >
	TemplateBodyNodePtr (const TemplateBodyNodePtr< OtherBodyNodeT > &_bnp)
	Templated constructor for copying other BodyNodePtrs.
	~TemplateBodyNodePtr ()
	Destructor. Releases the BodyNode reference before being destroyed.
TemplateBodyNodePtr &	operator= (const TemplateBodyNodePtr &bnp)
	User defined assignment operator.
template<class OtherBodyNodeT >
TemplateBodyNodePtr &	operator= (const TemplateBodyNodePtr< OtherBodyNodeT > &_bnp)
	Change the BodyNode that this BodyNodePtr references.
TemplateBodyNodePtr &	operator= (BodyNodeT *_ptr)
	Assignment operator.
	operator BodyNodeT * () const
	Implicit conversion.
BodyNodeT &	operator* () const
	Dereferencing operator.
BodyNodeT *	operator-> () const
	Dereferencing operation.
BodyNodeT *	get () const
	Get the raw BodyNode pointer.
void	set (BodyNodeT *_ptr)
	Set the BodyNode for this BodyNodePtr.

Detailed Description

template<class BodyNodeT>
class dart::dynamics::TemplateBodyNodePtr< BodyNodeT >

TemplateBodyNodePtr is a templated class that enables users to create a reference-counting BodyNodePtr.

Holding onto a BodyNodePtr will ensure that the BodyNode (and by extension, its Skeleton) does not get deleted. This remains true even if the BodyNode is moved into another Skeleton.

Constructor & Destructor Documentation

TemplateBodyNodePtr()

template<class BodyNodeT>

dart::dynamics::TemplateBodyNodePtr< BodyNodeT >::TemplateBodyNodePtr ( BodyNodeT *  _ptr )

inline

Typical constructor.

_ptr must be a valid pointer (or a nullptr) when passed to this constructor

---

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

• dart/dynamics/detail/BodyNodePtr.hpp