GeometryId Class Reference

Detailed Description

Type used to identify geometry instances in SceneGraph.

#include <drake/geometry/geometry_ids.h>

Public Member Functions
	GeometryId ()=default
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
	GeometryId (const GeometryId &)=default
GeometryId &	operator= (const GeometryId &)=default
	GeometryId (GeometryId &&)=default
GeometryId &	operator= (GeometryId &&)=default
Public Member Functions inherited from Identifier< class GeometryTag >
	Identifier ()
	Default constructor; the result is an invalid identifier.
int64_t	get_value () const
	Extracts the underlying representation from the identifier.
bool	is_valid () const
	Reports if the id is valid.
bool	operator== (Identifier other) const
	Compares one identifier with another of the same type for equality.
bool	operator!= (Identifier other) const
	Compares one identifier with another of the same type for inequality.
bool	operator< (Identifier other) const
	Compare two identifiers in order to define a total ordering among identifiers.
bool	is_same_as_valid_id (Identifier valid_id) const
	(Internal use only) Compares this possibly-invalid Identifier with one that is known to be valid and returns false if they don't match.
	Identifier (const Identifier &)=default
Identifier &	operator= (const Identifier &)=default
	Identifier (Identifier &&)=default
Identifier &	operator= (Identifier &&)=default

Static Public Member Functions
static GeometryId	get_new_id ()
Static Public Member Functions inherited from Identifier< class GeometryTag >
static Identifier	get_new_id ()
	Generates a new identifier for this id type.

Friends
class	internal::EncodedData

Additional Inherited Members
Protected Member Functions inherited from Identifier< class GeometryTag >
	Identifier (int64_t val)
Related Symbols inherited from Identifier< class GeometryTag >
std::ostream &	operator<< (std::ostream &out, const Identifier< class GeometryTag > &id)
	Streaming output operator.

Constructor & Destructor Documentation

GeometryId() [1/3]

GeometryId ( )

default

GeometryId() [2/3]

GeometryId ( const GeometryId & )

default

GeometryId() [3/3]

GeometryId ( GeometryId && )

default

Member Function Documentation

get_new_id()

GeometryId get_new_id ( )

static

operator=() [1/2]

GeometryId & operator= ( const GeometryId & )

default

operator=() [2/2]

GeometryId & operator= ( GeometryId && )

default

Friends And Related Symbol Documentation

internal::EncodedData

friend class internal::EncodedData

friend

---

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

• drake/geometry/geometry_ids.h