BRepGraph::RefsView Class Reference

Read-only view for RefId/RefUID-based reference storage. More...

#include <BRepGraph_RefsView.hxx>

Data Structures
class	ChildOps
	Generic child reference queries. More...
class	CoEdgeOps
	Coedge reference queries. More...
class	FaceOps
	Face reference queries. More...
class	OccurrenceOps
	Occurrence reference queries. More...
class	ShellOps
	Shell reference queries. More...
class	SolidOps
	Solid reference queries. More...
class	VertexOps
	Vertex reference queries. More...
class	WireOps
	Wire reference queries. More...

Public Member Functions
const ShellOps &	Shells () const
	Grouped shell reference queries.
const FaceOps &	Faces () const
	Grouped face reference queries.
const WireOps &	Wires () const
	Grouped wire reference queries.
const CoEdgeOps &	CoEdges () const
	Grouped coedge reference queries.
const VertexOps &	Vertices () const
	Grouped vertex reference queries.
const SolidOps &	Solids () const
	Grouped solid reference queries.
const ChildOps &	Children () const
	Grouped child reference queries.
const OccurrenceOps &	Occurrences () const
	Grouped occurrence reference queries.
BRepGraph_RefId	RefAtStep (const BRepGraph_NodeId theParent, const int theStep) const
	Return the direct parent-owned RefId stored at the specified child step. This is a structural lookup over the parent's raw ref arrays and does not skip removed refs or refs targeting removed child defs.
BRepGraph_NodeId	ChildNode (const BRepGraph_RefId theRef) const
	Resolve the child definition node referenced by any typed RefId.
bool	IsRemoved (const BRepGraph_RefId theRef) const
	Return true if the specified typed RefId is marked removed.
TopLoc_Location	LocalLocation (const BRepGraph_RefId theRef) const
	Return the local location carried by the specified typed RefId. OccurrenceRef and invalid refs return identity.
TopAbs_Orientation	Orientation (const BRepGraph_RefId theRef) const
	Return the orientation carried by the specified typed RefId. CoEdgeRef, OccurrenceRef, and invalid refs return TopAbs_FORWARD.

Detailed Description

Read-only view for RefId/RefUID-based reference storage.

This view exposes reference-entry storage:

• typed reference entry access (Shell, Face, ...)
• reference counts
• RefUID lookup and reverse lookup through BRepGraph::UIDs()
• stale tracking via BRepGraph_VersionStamp through BRepGraph::UIDs()

Identity semantics:

• RefId (kind + index) is graph-local and may change after Compact(). Use it for in-graph traversal and short-lived mutation logic.
• RefUID (kind + counter + generation) is stable across index remapping and intended for longer-lived identity tracking.

RefsView vs TopoView naming

RefsView accessors take reference IDs (BRepGraph_ShellRefId, BRepGraph_FaceRefId) and return reference-entry structs carrying per-use orientation and location. TopoView accessors take definition IDs (BRepGraph_ShellId, BRepGraph_FaceId) and return definition structs.

Iterating over references

Reference entries are primarily traversed in parent-owned context through the typed grouped IdsOf accessors. When flat iteration is needed, iterate using the matching typed RefId over the appropriate grouped Nb() or NbActive() count:

const BRepGraph::RefsView& aRefs = aGraph.Refs();
const BRepGraph_FaceRefId anEndFaceRefId = aRefs.Faces().EndId();
for (BRepGraph_FaceRefId aFaceRefId = aRefs.Faces().StartId();
     aFaceRefId < anEndFaceRefId;
     ++aFaceRefId)
{
  const BRepGraphInc::FaceRef& aFR = aRefs.Faces().Entry(aFaceRefId);
  if (aFR.IsRemoved)
    continue;
  // use aFR.FaceDefId, aFR.Orientation, aFR.Location ...
}

To iterate refs belonging to a specific parent, use the grouped IdsOf accessors:

for (const BRepGraph_WireRefId& aWireRefId : aRefs.Wires().IdsOf(aFaceId))
{
  const BRepGraphInc::WireRef& aWR = aRefs.Wires().Entry(aWireRefId);
  // ...
}

Member Function Documentation

ChildNode()

BRepGraph_NodeId BRepGraph::RefsView::ChildNode

(

const BRepGraph_RefId

theRef

)

const

Resolve the child definition node referenced by any typed RefId.

Children()

const ChildOps & BRepGraph::RefsView::Children ( ) const

inline

Grouped child reference queries.

CoEdges()

const CoEdgeOps & BRepGraph::RefsView::CoEdges ( ) const

inline

Grouped coedge reference queries.

Faces()

const FaceOps & BRepGraph::RefsView::Faces ( ) const

inline

Grouped face reference queries.

IsRemoved()

bool BRepGraph::RefsView::IsRemoved

(

const BRepGraph_RefId

theRef

)

const

Return true if the specified typed RefId is marked removed.

LocalLocation()

TopLoc_Location BRepGraph::RefsView::LocalLocation

(

const BRepGraph_RefId

theRef

)

const

Return the local location carried by the specified typed RefId. OccurrenceRef and invalid refs return identity.

Occurrences()

const OccurrenceOps & BRepGraph::RefsView::Occurrences ( ) const

inline

Grouped occurrence reference queries.

Orientation()

TopAbs_Orientation BRepGraph::RefsView::Orientation

(

const BRepGraph_RefId

theRef

)

const

Return the orientation carried by the specified typed RefId. CoEdgeRef, OccurrenceRef, and invalid refs return TopAbs_FORWARD.

RefAtStep()

BRepGraph_RefId BRepGraph::RefsView::RefAtStep	(	const BRepGraph_NodeId	theParent,
		const int	theStep ) const

Return the direct parent-owned RefId stored at the specified child step. This is a structural lookup over the parent's raw ref arrays and does not skip removed refs or refs targeting removed child defs.

Shells()

const ShellOps & BRepGraph::RefsView::Shells ( ) const

inline

Grouped shell reference queries.

Solids()

const SolidOps & BRepGraph::RefsView::Solids ( ) const

inline

Grouped solid reference queries.

Vertices()

const VertexOps & BRepGraph::RefsView::Vertices ( ) const

inline

Grouped vertex reference queries.

Wires()

const WireOps & BRepGraph::RefsView::Wires ( ) const

inline

Grouped wire reference queries.

---

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

• BRepGraph_RefsView.hxx