gz/physics/GetEntities.hh
virtual std::size_t GetLinkCount(const Identity &_modelID) const =0
Placeholder class in case a Feature does not define its own Link API.
Definition: gz/physics/Feature.hh:67
ConstJointPtr< PolicyT, FeaturesT > ConstJointPtrType
Definition: gz/physics/GetEntities.hh:306
ConstShapePtr< PolicyT, FeaturesT > ConstShapePtrType
Definition: gz/physics/GetEntities.hh:386
virtual Identity GetModelOfJoint(const Identity &_jointID) const =0
std::size_t GetWorldCount() const
Get the number of worlds inside this engine.
virtual std::size_t GetLinkIndex(const Identity &_linkID) const =0
Placeholder class in case a Feature does not define its own Shape API.
Definition: gz/physics/Feature.hh:85
STL class.
virtual std::size_t GetShapeIndex(const Identity &_shapeID) const =0
Definition: gz/physics/GetEntities.hh:434
virtual std::size_t GetJointCount(const Identity &_modelID) const =0
This feature retrieves the physics engine name in use.
Definition: gz/physics/GetEntities.hh:31
Definition: gz/physics/GetEntities.hh:382
JointPtrType GetJoint(std::size_t _index)
Get a Joint that exists within this Model.
Definition: gz/physics/GetEntities.hh:142
const std::string & GetName() const
Get the name of this Joint.
WorldPtr< PolicyT, FeaturesT > WorldPtrType
Definition: gz/physics/GetEntities.hh:65
EnginePtrType GetEngine()
Get the Engine that is managing this World.
This feature retrieves the joint pointer from the model by specifying model index and joint index/nam...
Definition: gz/physics/GetEntities.hh:299
ConstLinkPtr< PolicyT, FeaturesT > ConstLinkPtrType
Definition: gz/physics/GetEntities.hh:417
ModelPtr< PolicyT, FeaturesT > ModelPtrType
Definition: gz/physics/GetEntities.hh:145
virtual Identity GetJoint(const Identity &_modelID, std::size_t _jointIndex) const =0
This feature retrieves the shape pointer from the link by specifying link index and shape index/name.
Definition: gz/physics/GetEntities.hh:379
WorldPtrType GetWorld()
Get the World that contains this Model.
This feature retrieves the world pointer using index or name from the physics engine in use.
Definition: gz/physics/GetEntities.hh:59
virtual const std::string & GetModelName(const Identity &_modelID) const =0
std::size_t GetIndex() const
Get the index of this Shape within its Link.
virtual Identity GetLink(const Identity &_modelID, std::size_t _linkIndex) const =0
virtual std::size_t GetShapeCount(const Identity &_linkID) const =0
Definition: gz/physics/GetEntities.hh:253
ConstWorldPtr< PolicyT, FeaturesT > ConstWorldPtrType
Definition: gz/physics/GetEntities.hh:66
std::size_t GetModelCount() const
Get the number of Models inside this World.
virtual std::size_t GetWorldIndex(const Identity &_worldID) const =0
ModelPtrType GetModel(std::size_t _index)
Get a Model that exists within this World.
std::size_t GetIndex() const
Get the index of this engine. The meaning of an engine index is plugin-defined.
Use a FeatureList to aggregate a list of Features.
Definition: gz/physics/FeatureList.hh:51
virtual const std::string & GetShapeName(const Identity &_shapeID) const =0
ShapePtrType GetShape(std::size_t _index)
Get a Shape that exists within this Link.
EnginePtr< PolicyT, FeaturesT > EnginePtrType
Definition: gz/physics/GetEntities.hh:96
ConstWorldPtr< PolicyT, FeaturesT > ConstWorldPtrType
Definition: gz/physics/GetEntities.hh:177
Definition: gz/physics/GetEntities.hh:274
std::size_t GetIndex() const
Get the index of this Joint within its Model.
virtual const std::string & GetLinkName(const Identity &_linkID) const =0
LinkPtrType GetLink(std::size_t _index)
Get a Link that exists within this Model.
virtual Identity GetShape(const Identity &_linkID, std::size_t _shapeIndex) const =0
virtual Identity GetWorld(const Identity &_engineID, std::size_t _worldIndex) const =0
ModelPtrType GetModel()
Get the model that contains this Link.
Definition: gz/physics/GetEntities.hh:222
Definition: gz/physics/GetEntities.hh:194
virtual std::size_t GetJointIndex(const Identity &_jointID) const =0
Definition: gz/physics/Feature.hh:92
This class defines the concept of a Feature. It should be inherited by classes that define some plugi...
Definition: gz/physics/Feature.hh:35
ConstModelPtr< PolicyT, FeaturesT > ConstModelPtrType
Definition: gz/physics/GetEntities.hh:146
std::size_t GetIndex() const
Get the index of this Model within its World.
LinkPtr< PolicyT, FeaturesT > LinkPtrType
Definition: gz/physics/GetEntities.hh:225
virtual Identity GetWorldOfModel(const Identity &_modelID) const =0
virtual Identity GetModelOfLink(const Identity &_linkID) const =0
Placeholder class in case a Feature does not define its own Joint API.
Definition: gz/physics/Feature.hh:76
virtual Identity GetModel(const Identity &_worldID, std::size_t _modelIndex) const =0
LinkPtr< PolicyT, FeaturesT > LinkPtrType
Definition: gz/physics/GetEntities.hh:416
ConstModelPtr< PolicyT, FeaturesT > ConstModelPtrType
Definition: gz/physics/GetEntities.hh:337
WorldPtr< PolicyT, FeaturesT > WorldPtrType
Definition: gz/physics/GetEntities.hh:176
LinkPtrType GetLink()
Get the Link that contains this Shape.
virtual std::size_t GetWorldCount(const Identity &_engineID) const =0
const std::string & GetName() const
Get the name of this Shape.
Definition: gz/physics/GetEntities.hh:93
ConstModelPtr< PolicyT, FeaturesT > ConstModelPtrType
Definition: gz/physics/GetEntities.hh:257
virtual std::size_t GetModelCount(const Identity &_worldID) const =0
Placeholder class in case a Feature does not define its own Model API.
Definition: gz/physics/Feature.hh:58
ModelPtr< PolicyT, FeaturesT > ModelPtrType
Definition: gz/physics/GetEntities.hh:336
virtual const std::string & GetJointName(const Identity &_jointID) const =0
Definition: gz/physics/GetEntities.hh:456
virtual std::size_t GetModelIndex(const Identity &_modelID) const =0
Placeholder class in case a Feature does not define its own World API.
Definition: gz/physics/Feature.hh:49
ModelPtrType GetModel()
Get the model that contains this Link.
ConstEnginePtr< PolicyT, FeaturesT > ConstEnginePtrType
Definition: gz/physics/GetEntities.hh:97
Definition: gz/physics/GetEntities.hh:302
virtual Identity GetEngineOfWorld(const Identity &_worldID) const =0
virtual const std::string & GetWorldName(const Identity &_worldID) const =0
std::size_t GetIndex() const
Get the index of this World within its engine.
ShapePtr< PolicyT, FeaturesT > ShapePtrType
Definition: gz/physics/GetEntities.hh:385
Definition: gz/physics/GetEntities.hh:333
Definition: gz/physics/GetEntities.hh:114
std::size_t GetLinkCount() const
Get the number of Links within this Model.
virtual std::size_t GetEngineIndex(const Identity &_engineID) const =0
Definition: gz/physics/GetEntities.hh:62
std::size_t GetShapeCount() const
Get the number of Shapes within this Link.
JointPtr< PolicyT, FeaturesT > JointPtrType
Definition: gz/physics/GetEntities.hh:305
const std::string & GetName() const
Get the name of this Link.
Definition: gz/physics/GetEntities.hh:34
std::size_t GetIndex() const
Get the index of this Link within its Model.
Definition: gz/physics/GetEntities.hh:354
This feature retrieves the model pointer from the simulation world by specifying world index and mode...
Definition: gz/physics/GetEntities.hh:139
Placeholder class for the Engine API. Every Engine feature MUST inherit this class.
Definition: gz/physics/Feature.hh:40
virtual Identity GetLinkOfShape(const Identity &_shapeID) const =0
const std::string & GetName() const
Get the name of this Model.
Definition: gz/physics/GetEntities.hh:173
virtual const std::string & GetEngineName(const Identity &_engineID) const =0
This feature retrieves the link pointer from the model by specifying model index and link index/name.
Definition: gz/physics/GetEntities.hh:219
const std::string & GetName() const
Get the name of this World.
const std::string & GetName() const
Get the name of this engine. The meaning of an engine name is plugin-defined.
WorldPtrType GetWorld(std::size_t _index)
Get a world that is being managed by this engine.
ModelPtr< PolicyT, FeaturesT > ModelPtrType
Definition: gz/physics/GetEntities.hh:256
Definition: gz/physics/GetEntities.hh:413
std::size_t GetJointCount() const
Get the number of Joints within this Model.
ConstLinkPtr< PolicyT, FeaturesT > ConstLinkPtrType
Definition: gz/physics/GetEntities.hh:226
Definition: gz/physics/GetEntities.hh:46