Namespaces
	details

Functions
template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>
GeometryModel &	buildGeom (const ModelTpl< Scalar, Options, JointCollectionTpl > &model, const std::string &filename, const GeometryType type, GeometryModel &geomModel, const std::string &rootLinkName, const std::string &packagePath, ::hpp::fcl::MeshLoaderPtr meshLoader=::hpp::fcl::MeshLoaderPtr())
	Build The GeometryModel from a SDF file. Search for meshes in the directories specified by the user first and then in the environment variable ROS_PACKAGE_PATH. More...

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>
GeometryModel &	buildGeom (const ModelTpl< Scalar, Options, JointCollectionTpl > &model, const std::string &filename, const GeometryType type, GeometryModel &geomModel, const std::string &rootLinkName="", const std::vector< std::string > &packageDirs=std::vector< std::string >(), ::hpp::fcl::MeshLoaderPtr meshLoader=::hpp::fcl::MeshLoaderPtr())
	Build The GeometryModel from a SDF file. Search for meshes in the directories specified by the user first and then in the environment variable ROS_PACKAGE_PATH. More...

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>
GeometryModel &	buildGeom (const ModelTpl< Scalar, Options, JointCollectionTpl > &model, PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &contact_models, const std::string &filename, const GeometryType type, GeometryModel &geomModel, const std::string &packagePath, ::hpp::fcl::MeshLoaderPtr meshLoader=::hpp::fcl::MeshLoaderPtr())
	Build The GeometryModel from a SDF file. Search for meshes in the directories specified by the user first and then in the environment variable ROS_PACKAGE_PATH. More...

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>
ModelTpl< Scalar, Options, JointCollectionTpl > &	buildModel (const std::string &filename, const typename ModelTpl< Scalar, Options, JointCollectionTpl >::JointModel &rootJoint, const std::string &rootJointName, ModelTpl< Scalar, Options, JointCollectionTpl > &model, PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &contact_models, const std::string &rootLinkName="", const std::vector< std::string > &parentGuidance={}, const bool verbose=false)
	Build the model from a SDF file with a particular joint as root of the model tree inside the model given as reference argument. More...

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>
ModelTpl< Scalar, Options, JointCollectionTpl > &	buildModel (const std::string &filename, const typename ModelTpl< Scalar, Options, JointCollectionTpl >::JointModel &rootJoint, ModelTpl< Scalar, Options, JointCollectionTpl > &model, PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &contact_models, const std::string &rootLinkName="", const std::vector< std::string > &parentGuidance={}, const bool verbose=false)
	Build the model from a SDF file with a particular joint as root of the model tree inside the model given as reference argument. More...

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>
ModelTpl< Scalar, Options, JointCollectionTpl > &	buildModel (const std::string &filename, ModelTpl< Scalar, Options, JointCollectionTpl > &model, PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &contact_models, const std::string &rootLinkName="", const std::vector< std::string > &parentGuidance={}, const bool verbose=false)
	Build the model from a SDF file with a fixed joint as root of the model tree. More...

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>
ModelTpl< Scalar, Options, JointCollectionTpl > &	buildModelFromXML (const std::string &xmlStream, const typename ModelTpl< Scalar, Options, JointCollectionTpl >::JointModel &rootJoint, const std::string &rootJointName, ModelTpl< Scalar, Options, JointCollectionTpl > &model, PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &contact_models, const std::string &rootLinkName="", const std::vector< std::string > &parentGuidance={}, const bool verbose=false)
	Build the model from an XML stream with a particular joint as root of the model tree inside the model given as reference argument. More...

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>
ModelTpl< Scalar, Options, JointCollectionTpl > &	buildModelFromXML (const std::string &xmlStream, const typename ModelTpl< Scalar, Options, JointCollectionTpl >::JointModel &rootJoint, ModelTpl< Scalar, Options, JointCollectionTpl > &model, PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &contact_models, const std::string &rootLinkName="", const std::vector< std::string > &parentGuidance={}, const bool verbose=false)
	Build the model from an XML stream with a particular joint as root of the model tree inside the model given as reference argument. More...

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>
ModelTpl< Scalar, Options, JointCollectionTpl > &	buildModelFromXML (const std::string &xmlStream, ModelTpl< Scalar, Options, JointCollectionTpl > &model, PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &contact_models, const std::string &rootLinkName="", const std::vector< std::string > &parentGuidance={}, const bool verbose=false)
	Build the model from an xml stream with a fixed joint as root of the model tree. More...

Function Documentation

◆ buildGeom() [1/3]

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>

GeometryModel& pinocchio::sdf::buildGeom	(	const ModelTpl< Scalar, Options, JointCollectionTpl > &	model,
		const std::string &	filename,
		const GeometryType	type,
		GeometryModel &	geomModel,
		const std::string &	rootLinkName,
		const std::string &	packagePath,
		::hpp::fcl::MeshLoaderPtr	meshLoader = `::hpp::fcl::MeshLoaderPtr()`
	)

Build The GeometryModel from a SDF file. Search for meshes in the directories specified by the user first and then in the environment variable ROS_PACKAGE_PATH.

Parameters

[in]	model	The model of the robot, built with sdf::buildModel
[in]	filename	The SDF complete (absolute) file path
[in]	package_path	A string containing the path to the directories of the meshes, typically obtained from calling pinocchio::rosPaths().
[in]	type	The type of objects that must be loaded (must be VISUAL or COLLISION)
[in]	rootLinkName	Name of the root link
[in]	meshLoader	object used to load meshes: hpp::fcl::MeshLoader [default] or hpp::fcl::CachedMeshLoader.
[out]	geomModel	Reference where to put the parsed information.

Returns: Returns the reference on geom model for convenience.

Warning: If hpp-fcl has not been found during compilation, COLLISION objects can not be loaded

Definition at line 115 of file parsers/sdf.hpp.

◆ buildGeom() [2/3]

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>

GeometryModel& pinocchio::sdf::buildGeom	(	const ModelTpl< Scalar, Options, JointCollectionTpl > &	model,
		const std::string &	filename,
		const GeometryType	type,
		GeometryModel &	geomModel,
		const std::string &	rootLinkName = `""`,
		const std::vector< std::string > &	packageDirs = `std::vector< std::string >()`,
		::hpp::fcl::MeshLoaderPtr	meshLoader = `::hpp::fcl::MeshLoaderPtr()`
	)

Build The GeometryModel from a SDF file. Search for meshes in the directories specified by the user first and then in the environment variable ROS_PACKAGE_PATH.

Parameters

[in]	model	The model of the robot, built with sdf::buildModel
[in]	filename	The SDF complete (absolute) file path
[in]	packageDirs	A vector containing the different directories where to search for models and meshes, typically obtained from calling pinocchio::rosPaths()
[in]	type	The type of objects that must be loaded (must be VISUAL or COLLISION)
[in]	rootLinkName	Name of the root link
[in]	meshLoader	object used to load meshes: hpp::fcl::MeshLoader [default] or hpp::fcl::CachedMeshLoader.
[out]	geomModel	Reference where to put the parsed information.

Returns: Returns the reference on geom model for convenience.

Warning: If hpp-fcl has not been found during compilation, COLLISION objects can not be loaded

◆ buildGeom() [3/3]

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>

GeometryModel& pinocchio::sdf::buildGeom	(	const ModelTpl< Scalar, Options, JointCollectionTpl > &	model,
		PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &	contact_models,
		const std::string &	filename,
		const GeometryType	type,
		GeometryModel &	geomModel,
		const std::string &	packagePath,
		::hpp::fcl::MeshLoaderPtr	meshLoader = `::hpp::fcl::MeshLoaderPtr()`
	)

Build The GeometryModel from a SDF file. Search for meshes in the directories specified by the user first and then in the environment variable ROS_PACKAGE_PATH.

Parameters

[in]	model	The model of the robot, built with sdf::buildModel
[in]	filename	The SDF complete (absolute) file path
[in]	package_path	A string containing the path to the directories of the meshes, typically obtained from calling pinocchio::rosPaths().
[in]	type	The type of objects that must be loaded (must be VISUAL or COLLISION)
[in]	meshLoader	object used to load meshes: hpp::fcl::MeshLoader [default] or hpp::fcl::CachedMeshLoader.
[out]	geomModel	Reference where to put the parsed information.

Returns: Returns the reference on geom model for convenience.

Warning: If hpp-fcl has not been found during compilation, COLLISION objects can not be loaded

Definition at line 77 of file parsers/sdf.hpp.

◆ buildModel() [1/3]

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>

ModelTpl<Scalar, Options, JointCollectionTpl>& pinocchio::sdf::buildModel	(	const std::string &	filename,
		const typename ModelTpl< Scalar, Options, JointCollectionTpl >::JointModel &	rootJoint,
		const std::string &	rootJointName,
		ModelTpl< Scalar, Options, JointCollectionTpl > &	model,
		PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &	contact_models,
		const std::string &	rootLinkName = `""`,
		const std::vector< std::string > &	parentGuidance = `{}`,
		const bool	verbose = `false`
	)

Build the model from a SDF file with a particular joint as root of the model tree inside the model given as reference argument.

Parameters

[in]	filename	The SDF complete file path.
[in]	rootJoint	The joint at the root of the model tree.*
[in]	rootJointName	Name of the rootJoint.
[in]	parentGuidance	Joint names which should be preferred for cases where two joints can qualify as parent. The other joint appears in the constraint_model. If empty, joint appearance order in .sdf is taken as default.
[in]	verbose	Print parsing info.
[out]	model	Reference model where to put the parsed information.

Returns: Return the reference on argument model for convenience.

◆ buildModel() [2/3]

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>

ModelTpl<Scalar, Options, JointCollectionTpl>& pinocchio::sdf::buildModel	(	const std::string &	filename,
		const typename ModelTpl< Scalar, Options, JointCollectionTpl >::JointModel &	rootJoint,
		ModelTpl< Scalar, Options, JointCollectionTpl > &	model,
		PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &	contact_models,
		const std::string &	rootLinkName = `""`,
		const std::vector< std::string > &	parentGuidance = `{}`,
		const bool	verbose = `false`
	)

Build the model from a SDF file with a particular joint as root of the model tree inside the model given as reference argument.

Parameters

[in]	filename	The SDF complete file path.
[in]	rootJoint	The joint at the root of the model tree.*
[in]	parentGuidance	Joint names which should be preferred for cases where two joints can qualify as parent. The other joint appears in the constraint_model. If empty, joint appearance order in .sdf is taken as default.
[in]	verbose	Print parsing info.
[out]	model	Reference model where to put the parsed information.

Returns: Return the reference on argument model for convenience.

◆ buildModel() [3/3]

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>

ModelTpl<Scalar, Options, JointCollectionTpl>& pinocchio::sdf::buildModel	(	const std::string &	filename,
		ModelTpl< Scalar, Options, JointCollectionTpl > &	model,
		PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &	contact_models,
		const std::string &	rootLinkName = `""`,
		const std::vector< std::string > &	parentGuidance = `{}`,
		const bool	verbose = `false`
	)

Build the model from a SDF file with a fixed joint as root of the model tree.

Parameters

[in]	filename	The SDF complete file path.
[in]	verbose	Print parsing info.
[out]	model	Reference model where to put the parsed information.

Returns: Return the reference on argument model for convenience.

◆ buildModelFromXML() [1/3]

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>

ModelTpl<Scalar, Options, JointCollectionTpl>& pinocchio::sdf::buildModelFromXML	(	const std::string &	xmlStream,
		const typename ModelTpl< Scalar, Options, JointCollectionTpl >::JointModel &	rootJoint,
		const std::string &	rootJointName,
		ModelTpl< Scalar, Options, JointCollectionTpl > &	model,
		PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &	contact_models,
		const std::string &	rootLinkName = `""`,
		const std::vector< std::string > &	parentGuidance = `{}`,
		const bool	verbose = `false`
	)

Build the model from an XML stream with a particular joint as root of the model tree inside the model given as reference argument.

Parameters

[in]	xmlStream	xml stream containing SDF model
[in]	rootJoint	The joint at the root of the model tree.
[in]	rootJointName	Name of the rootJoint.
[in]	parentGuidance	Joint names which should be preferred for cases where two joints can qualify as parent. The other joint appears in the constraint_model. If empty, joint appearance order in .sdf is taken as default.
[in]	verbose	Print parsing info.
[out]	model	Reference model where to put the parsed information.

Returns: Return the reference on argument model for convenience.

◆ buildModelFromXML() [2/3]

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>

ModelTpl<Scalar, Options, JointCollectionTpl>& pinocchio::sdf::buildModelFromXML	(	const std::string &	xmlStream,
		const typename ModelTpl< Scalar, Options, JointCollectionTpl >::JointModel &	rootJoint,
		ModelTpl< Scalar, Options, JointCollectionTpl > &	model,
		PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &	contact_models,
		const std::string &	rootLinkName = `""`,
		const std::vector< std::string > &	parentGuidance = `{}`,
		const bool	verbose = `false`
	)

Build the model from an XML stream with a particular joint as root of the model tree inside the model given as reference argument.

Parameters

[in]	xmlStream	xml stream containing SDF model
[in]	rootJoint	The joint at the root of the model tree.
[in]	parentGuidance	Joint names which should be preferred for cases where two joints can qualify as parent. The other joint appears in the constraint_model. If empty, joint appearance order in .sdf is taken as default.
[in]	verbose	Print parsing info.
[out]	model	Reference model where to put the parsed information.

Returns: Return the reference on argument model for convenience.

◆ buildModelFromXML() [3/3]

template<typename Scalar , int Options, template< typename, int > class JointCollectionTpl>

ModelTpl<Scalar, Options, JointCollectionTpl>& pinocchio::sdf::buildModelFromXML	(	const std::string &	xmlStream,
		ModelTpl< Scalar, Options, JointCollectionTpl > &	model,
		PINOCCHIO_STD_VECTOR_WITH_EIGEN_ALLOCATOR(RigidConstraintModel) &	contact_models,
		const std::string &	rootLinkName = `""`,
		const std::vector< std::string > &	parentGuidance = `{}`,
		const bool	verbose = `false`
	)

Build the model from an xml stream with a fixed joint as root of the model tree.

Parameters

[in]	xmlStream	The xml stream containing the SDF Model.
[in]	verbose	Print parsing info.
[out]	model	Reference model where to put the parsed information.

Returns: Return the reference on argument model for convenience.

Namespaces

Functions

Function Documentation

◆ buildGeom() [1/3]

◆ buildGeom() [2/3]

◆ buildGeom() [3/3]

◆ buildModel() [1/3]

◆ buildModel() [2/3]

◆ buildModel() [3/3]

◆ buildModelFromXML() [1/3]

◆ buildModelFromXML() [2/3]

◆ buildModelFromXML() [3/3]