Open CASCADE Technology  7.2.0
Public Member Functions | Static Public Member Functions

TNaming_Selector Class Reference

This class provides a single API for selection of shapes. This involves both identification and selection of shapes in the data framework. If the selected shape is modified, this selector will solve its identifications. This class is the user interface for topological naming resources. More...

#include <TNaming_Selector.hxx>

Public Member Functions

 TNaming_Selector (const TDF_Label &aLabel)
 Create a selector on this label

<>to select a shape. More...
 
Standard_Boolean Select (const TopoDS_Shape &Selection, const TopoDS_Shape &Context, const Standard_Boolean Geometry=Standard_False, const Standard_Boolean KeepOrientatation=Standard_False) const
 Creates a topological naming on the label aLabel given as an argument at construction time. If successful, the shape Selection - found in the shape Context - is now identified in the named shape returned in NamedShape. If Geometry is true, NamedShape contains the first appearance of Selection. This syntax is more robust than the previous syntax for this method. More...
 
Standard_Boolean Select (const TopoDS_Shape &Selection, const Standard_Boolean Geometry=Standard_False, const Standard_Boolean KeepOrientatation=Standard_False) const
 Creates a topological naming on the label aLabel given as an argument at construction time. If successful, the shape Selection is now identified in the named shape returned in NamedShape. If Geometry is true, NamedShape contains the first appearance of Selection. More...
 
Standard_Boolean Solve (TDF_LabelMap &Valid) const
 Updates the topological naming on the label aLabel given as an argument at construction time. The underlying shape returned in the method NamedShape is updated. To read this shape, use the method TNaming_Tool::GetShape. More...
 
void Arguments (TDF_AttributeMap &args) const
 Returns the attribute list args. This list contains the named shape on which the topological naming was built. More...
 
Handle< TNaming_NamedShapeNamedShape () const
 Returns the NamedShape build or under construction, which contains the topological naming.. More...
 

Static Public Member Functions

static Standard_Boolean IsIdentified (const TDF_Label &access, const TopoDS_Shape &selection, Handle< TNaming_NamedShape > &NS, const Standard_Boolean Geometry=Standard_False)
 <>To know if a shape is already identified (not selected) More...
 

Detailed Description

This class provides a single API for selection of shapes. This involves both identification and selection of shapes in the data framework. If the selected shape is modified, this selector will solve its identifications. This class is the user interface for topological naming resources.

Constructor & Destructor Documentation

◆ TNaming_Selector()

TNaming_Selector::TNaming_Selector ( const TDF_Label aLabel)

Create a selector on this label

<>to select a shape.

Member Function Documentation

◆ Arguments()

void TNaming_Selector::Arguments ( TDF_AttributeMap args) const

Returns the attribute list args. This list contains the named shape on which the topological naming was built.

◆ IsIdentified()

static Standard_Boolean TNaming_Selector::IsIdentified ( const TDF_Label access,
const TopoDS_Shape selection,
Handle< TNaming_NamedShape > &  NS,
const Standard_Boolean  Geometry = Standard_False 
)
static

<>To know if a shape is already identified (not selected)

The label access defines the point of access to the data framework. selection is the shape for which we want to know whether it is identified or not. If true, NS is returned as the identity of selection. If Geometry is true, NS will be the named shape containing the first appearance of selection and not any other shape. In other words, selection must be the only shape stored in NS.

◆ NamedShape()

Handle< TNaming_NamedShape > TNaming_Selector::NamedShape ( ) const

Returns the NamedShape build or under construction, which contains the topological naming..

◆ Select() [1/2]

Standard_Boolean TNaming_Selector::Select ( const TopoDS_Shape Selection,
const TopoDS_Shape Context,
const Standard_Boolean  Geometry = Standard_False,
const Standard_Boolean  KeepOrientatation = Standard_False 
) const

Creates a topological naming on the label aLabel given as an argument at construction time. If successful, the shape Selection - found in the shape Context - is now identified in the named shape returned in NamedShape. If Geometry is true, NamedShape contains the first appearance of Selection. This syntax is more robust than the previous syntax for this method.

◆ Select() [2/2]

Standard_Boolean TNaming_Selector::Select ( const TopoDS_Shape Selection,
const Standard_Boolean  Geometry = Standard_False,
const Standard_Boolean  KeepOrientatation = Standard_False 
) const

Creates a topological naming on the label aLabel given as an argument at construction time. If successful, the shape Selection is now identified in the named shape returned in NamedShape. If Geometry is true, NamedShape contains the first appearance of Selection.

◆ Solve()

Standard_Boolean TNaming_Selector::Solve ( TDF_LabelMap Valid) const

Updates the topological naming on the label aLabel given as an argument at construction time. The underlying shape returned in the method NamedShape is updated. To read this shape, use the method TNaming_Tool::GetShape.


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