BRepGraph_ChildExplorer::Config Struct Reference

Consolidated configuration for the explorer. More...

#include <BRepGraph_ChildExplorer.hxx>

Data Fields
TraversalMode	Mode = TraversalMode::Recursive
std::optional< BRepGraph_NodeId::Kind >	TargetKind
	Emit only this kind (no value = emit all).
std::optional< BRepGraph_NodeId::Kind >	AvoidKind
	Do not descend into this kind.
bool	EmitAvoidKind
	Emit matching avoid-kind nodes once before skipping their subtree.
bool	AccumulateLocation = true
	Compose Location down the walk.
bool	AccumulateOrientation = true
	Compose Orientation down the walk.
TopLoc_Location	StartLoc
	Initial accumulated location.
TopAbs_Orientation	StartOri = TopAbs_FORWARD
	Initial accumulated orientation.

Detailed Description

Consolidated configuration for the explorer.

Prefer this struct over the historical 11-overload constructor family. The overloads remain supported for existing callers but the Config-based constructor is the stable long-term idiom: new options can be added as fields without another constructor explosion.

BRepGraph_ChildExplorer::Config aConfig;
aConfig.Mode        = BRepGraph_ChildExplorer::TraversalMode::DirectChildren;
aConfig.TargetKind  = BRepGraph_NodeId::Kind::Face;
aConfig.StartLoc    = aParentLocation;
aConfig.StartOri    = TopAbs_REVERSED;
for (auto [id, loc, ori] : BRepGraph_ChildExplorer(aGraph, aRoot, aConfig)) { ... }

Field Documentation

AccumulateLocation

bool BRepGraph_ChildExplorer::Config::AccumulateLocation = true

Compose Location down the walk.

AccumulateOrientation

bool BRepGraph_ChildExplorer::Config::AccumulateOrientation = true

Compose Orientation down the walk.

AvoidKind

std::optional<BRepGraph_NodeId::Kind> BRepGraph_ChildExplorer::Config::AvoidKind

Do not descend into this kind.

EmitAvoidKind

bool BRepGraph_ChildExplorer::Config::EmitAvoidKind

Initial value:

=
      false

Emit matching avoid-kind nodes once before skipping their subtree.

Mode

TraversalMode BRepGraph_ChildExplorer::Config::Mode = TraversalMode::Recursive

StartLoc

TopLoc_Location BRepGraph_ChildExplorer::Config::StartLoc

Initial accumulated location.

StartOri

TopAbs_Orientation BRepGraph_ChildExplorer::Config::StartOri = TopAbs_FORWARD

Initial accumulated orientation.

TargetKind

std::optional<BRepGraph_NodeId::Kind> BRepGraph_ChildExplorer::Config::TargetKind

Emit only this kind (no value = emit all).

---

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

• BRepGraph_ChildExplorer.hxx