Loading...
Searching...
No Matches
SdfLayer::DetachedLayerRules Class Reference

Object used to specify detached layers. More...

#include <layer.h>

Public Member Functions

 DetachedLayerRules ()=default
 A default constructed rules object Excludes all layers from the detached layer set.
 
DetachedLayerRulesIncludeAll ()
 Include all layers in the detached layer set.
 
SDF_API DetachedLayerRulesInclude (const std::vector< std::string > &patterns)
 Include layers whose identifiers contain any of the strings in patterns in the detached layer set.
 
SDF_API DetachedLayerRulesExclude (const std::vector< std::string > &patterns)
 Exclude layers whose identifiers contain any of the strings in patterns from the detached layer set.
 
bool IncludedAll () const
 
const std::vector< std::string > & GetIncluded () const
 
const std::vector< std::string > & GetExcluded () const
 
SDF_API bool IsIncluded (const std::string &identifier) const
 Returns true if identifier is included in the detached layer set, false otherwise.
 

Friends

class SdfLayer
 

Detailed Description

Object used to specify detached layers.

Layers may be included or excluded from the detached layer set by specifying simple substring patterns for layer identifiers. For example, the following will include all layers in the detached layer set, except for those whose identifiers contain the substring "sim" or "geom":

.Exclude({"sim", "geom"})
);
Object used to specify detached layers.
Definition: layer.h:1290
DetachedLayerRules & IncludeAll()
Include all layers in the detached layer set.
Definition: layer.h:1297
SDF_API DetachedLayerRules & Exclude(const std::vector< std::string > &patterns)
Exclude layers whose identifiers contain any of the strings in patterns from the detached layer set.
static SDF_API void SetDetachedLayerRules(const DetachedLayerRules &mask)
Sets the rules specifying detached layers.

Definition at line 1289 of file layer.h.

Constructor & Destructor Documentation

◆ DetachedLayerRules()

DetachedLayerRules ( )
default

A default constructed rules object Excludes all layers from the detached layer set.

Member Function Documentation

◆ Exclude()

SDF_API DetachedLayerRules & Exclude ( const std::vector< std::string > &  patterns)

Exclude layers whose identifiers contain any of the strings in patterns from the detached layer set.

◆ GetExcluded()

const std::vector< std::string > & GetExcluded ( ) const
inline

Definition at line 1316 of file layer.h.

◆ GetIncluded()

const std::vector< std::string > & GetIncluded ( ) const
inline

Definition at line 1315 of file layer.h.

◆ Include()

SDF_API DetachedLayerRules & Include ( const std::vector< std::string > &  patterns)

Include layers whose identifiers contain any of the strings in patterns in the detached layer set.

◆ IncludeAll()

DetachedLayerRules & IncludeAll ( )
inline

Include all layers in the detached layer set.

Definition at line 1297 of file layer.h.

◆ IncludedAll()

bool IncludedAll ( ) const
inline

Definition at line 1314 of file layer.h.

◆ IsIncluded()

SDF_API bool IsIncluded ( const std::string &  identifier) const

Returns true if identifier is included in the detached layer set, false otherwise.

identifier is included if it matches an include pattern (or the mask includes all identifiers) and it does not match any of the exclude patterns. Anonymous layer identifiers are always excluded from the mask.

Friends And Related Function Documentation

◆ SdfLayer

friend class SdfLayer
friend

Definition at line 1329 of file layer.h.


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