Object used to specify detached layers.
More...
#include <layer.h>
|
| DetachedLayerRules ()=default |
| A default constructed rules object Excludes all layers from the detached layer set.
|
|
DetachedLayerRules & | IncludeAll () |
| Include all layers in the detached layer set.
|
|
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.
|
|
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.
|
|
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.
|
|
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":
);
Object used to specify detached layers.
DetachedLayerRules & IncludeAll()
Include all layers in the detached layer set.
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 1258 of file layer.h.
◆ DetachedLayerRules()
A default constructed rules object Excludes all layers from the detached layer set.
◆ Exclude()
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 |
◆ GetIncluded()
const std::vector< std::string > & GetIncluded |
( |
| ) |
const |
|
inline |
◆ Include()
Include layers whose identifiers contain any of the strings in patterns
in the detached layer set.
◆ IncludeAll()
Include all layers in the detached layer set.
Definition at line 1266 of file layer.h.
◆ IncludedAll()
bool IncludedAll |
( |
| ) |
const |
|
inline |
◆ 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.
◆ SdfLayer
The documentation for this class was generated from the following file: