Detailed Description

Directive to add a collision filter group.

This directive is analogous to drake:collision_filter_group in XML model formats.

#include <drake/multibody/parsing/model_directives.h>

Public Member Functions
bool	IsValid () const

template<typename Archive >
void	Serialize (Archive *a)

Public Attributes
std::string	name
	Name of group to be added. More...

std::optional< std::string >	model_namespace
	Optional model namespace. More...

std::vector< std::string >	members
	Names of members of the group. More...

std::vector< std::string >	member_groups
	Names of groups to add en masse as members of the group. More...

std::vector< std::string >	ignored_collision_filter_groups
	Names of groups against which to ignore collisions. More...

Member Function Documentation

◆ IsValid()

bool IsValid ( ) const

◆ Serialize()

void Serialize ( Archive * a )

Member Data Documentation

◆ ignored_collision_filter_groups

std::vector<std::string> ignored_collision_filter_groups

Names of groups against which to ignore collisions.

If another group is named, collisions between this group and that group will be ignored. If this group is named, collisions within this group will be ignored. Names may be scoped and refer to other groups defined elsewhere in this file or transitively included directives or model files. This data is analogous to a sequence of drake:ignored_collision_filter_group in XML model formats.

◆ member_groups

std::vector<std::string> member_groups

Names of groups to add en masse as members of the group.

May be scoped and refer to bodies of already added models. This data is analogous to a sequence of drake:member_group in XML model formats.

◆ members

std::vector<std::string> members

Names of members of the group.

May be scoped and refer to bodies of already added models. This data is analogous to a sequence of drake:member in XML model formats.

◆ model_namespace

std::optional<std::string> model_namespace

Optional model namespace.

Allows name to be reused between models and lets you use the scoped name in ignored_collision_filter_groups.

◆ name

std::string name

Name of group to be added.

This is an unscoped name, and must be unique either globally or within its specified model namespace.

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

drake/multibody/parsing/model_directives.h