OCC.Core.TNaming module¶

TNaming module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_tnaming.html

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

property thisown¶: The membership flag

value()¶

class TNaming_Builder(*args)¶

Bases: object

Create an Builder. Warning: Before Addition copies the current Value, and clear

param aLabel

type aLabel

TDF_Label

rtype

None

Delete()¶

Records the shape oldShape which was deleted from the current label. As an example, consider the case of a face removed by a Boolean operation.

param oldShape

type oldShape

TopoDS_Shape

rtype

None

Generated()¶

Records the shape newShape which was generated during a topological construction. As an example, consider the case of a face generated in construction of a box.

param newShape

type newShape

TopoDS_Shape

rtype

None* Records the shape newShape which was generated from the shape oldShape during a topological construction. As an example, consider the case of a face generated from an edge in construction of a prism.

param oldShape

type oldShape

TopoDS_Shape

param newShape

type newShape

TopoDS_Shape

rtype

None

Modify()¶

Records the shape newShape which is a modification of the shape oldShape. As an example, consider the case of a face split or merged in a Boolean operation.

param oldShape

type oldShape

TopoDS_Shape

param newShape

type newShape

TopoDS_Shape

rtype

None

NamedShape()¶

Returns the NamedShape which has been built or is under construction.

rtype

opencascade::handle<TNaming_NamedShape>

Select()¶

Add a Shape to the current label , This Shape is unmodified. Used for example to define a set of shapes under a label.

param aShape

type aShape

TopoDS_Shape

param inShape

type inShape

TopoDS_Shape

rtype

None

property thisown¶: The membership flag

class TNaming_CopyShape¶

Bases: object

static CopyTool()¶

Makes copy a set of shape(s), using the aMap

param aShape

type aShape

TopoDS_Shape

param aMap

type aMap

TColStd_IndexedDataMapOfTransientTransient

param aResult

type aResult

TopoDS_Shape

rtype

void

static Translate()¶

Translates a Transient shape(s) to Transient

param aShape

type aShape

TopoDS_Shape

param aMap

type aMap

TColStd_IndexedDataMapOfTransientTransient

param aResult

type aResult

TopoDS_Shape

param TrTool

type TrTool

TNaming_TranslateTool

rtype

void* Translates a Topological Location to an other Top. Location

param L

type L

TopLoc_Location

param aMap

type aMap

TColStd_IndexedDataMapOfTransientTransient

rtype

TopLoc_Location

property thisown¶: The membership flag

class TNaming_DataMapOfShapeMapOfShape(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TNaming_DataMapOfShapePtrRefShape(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TNaming_DataMapOfShapeShapesSet(*args)¶

Bases: object

Assign()¶

Bind()¶

Bound()¶

ChangeFind()¶

ChangeSeek()¶

Clear()¶

Exchange()¶

Find()¶

IsBound()¶

ReSize()¶

Seek()¶

Set()¶

Size()¶

UnBind()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TNaming_DeltaOnModification(*args)¶

Bases: OCC.Core.TDF.TDF_DeltaOnModification

Initializes a TDF_DeltaOnModification.

param NS

type NS

TNaming_NamedShape

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class TNaming_DeltaOnRemoval(*args)¶

Bases: OCC.Core.TDF.TDF_DeltaOnRemoval

Initializes a TDF_DeltaOnModification.

param NS

type NS

TNaming_NamedShape

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class TNaming_Identifier(*args)¶

Bases: object

Parameters

Lab –

type Lab: TDF_Label
param S
type S: TopoDS_Shape
param Context
type Context: TopoDS_Shape
param Geom
type Geom: bool
rtype: None:param Lab:
type Lab: TDF_Label
param S
type S: TopoDS_Shape
param ContextNS
type ContextNS: TNaming_NamedShape
param Geom
type Geom: bool
rtype: None

AncestorIdentification()¶

Parameters

Localizer –

type Localizer: TNaming_Localizer
param Context
type Context: TopoDS_Shape
rtype: None

ArgIsFeature()¶

Return type: bool

Feature()¶

Return type: opencascade::handle<TNaming_NamedShape>

FeatureArg()¶

Return type: opencascade::handle<TNaming_NamedShape>

GeneratedIdentification()¶

Parameters

Localizer –

type Localizer: TNaming_Localizer
param NS
type NS: TNaming_NamedShape
rtype: None

Identification()¶

Parameters

Localizer –

type Localizer: TNaming_Localizer
param NS
type NS: TNaming_NamedShape
rtype: None

InitArgs()¶

Return type: None

IsDone()¶

Return type: bool

IsFeature()¶

Return type: bool

MoreArgs()¶

Return type: bool

NamedShapeOfGeneration()¶

Return type: opencascade::handle<TNaming_NamedShape>

NextArg()¶

Return type: None

PrimitiveIdentification()¶

Parameters

Localizer –

type Localizer: TNaming_Localizer
param NS
type NS: TNaming_NamedShape
rtype: None

ShapeArg()¶

Return type: TopoDS_Shape

ShapeContext()¶

Return type: TopoDS_Shape

Type()¶

Return type: TNaming_NameType

property thisown¶: The membership flag

class TNaming_Iterator(*args)¶

Bases: object

Iterates on all the history records in <anAtt>.

param anAtt

type anAtt

TNaming_NamedShape

rtype

None* Iterates on all the history records in the current transaction

param aLabel

type aLabel

TDF_Label

rtype

None* Iterates on all the history records in the transaction <aTrans>

param aLabel

type aLabel

TDF_Label

param aTrans

type aTrans

int

rtype

None

Evolution()¶

Return type: TNaming_Evolution

IsModification()¶

Returns true if the new shape is a modification (split, fuse,etc…) of the old shape.

rtype

bool

More()¶

Returns True if there is a current Item in the iteration.

rtype

bool

NewShape()¶

Returns the new shape in this iterator object.

rtype

TopoDS_Shape

Next()¶

Moves the iteration to the next Item

rtype

None

OldShape()¶

Returns the old shape in this iterator object. This shape can be a null one.

rtype

TopoDS_Shape

property thisown¶: The membership flag

class TNaming_IteratorOnShapesSet(*args)¶

Bases: object

Return type: None:param S: :type S: TNaming_ShapesSet :rtype: None

Init()¶

Initialize the iteration

param S

type S

TNaming_ShapesSet

rtype

None

More()¶

Returns True if there is a current Item in the iteration.

rtype

bool

Next()¶

Move to the next Item

rtype

None

Value()¶

Return type: TopoDS_Shape

property thisown¶: The membership flag

class TNaming_ListIteratorOfListOfIndexedDataMapOfShapeListOfShape(*args)¶

Bases: object

ChangeValue()¶

More()¶

Next()¶

Value()¶

property thisown¶: The membership flag

class TNaming_ListIteratorOfListOfMapOfShape(*args)¶

Bases: object

ChangeValue()¶

More()¶

Next()¶

Value()¶

property thisown¶: The membership flag

class TNaming_ListIteratorOfListOfNamedShape(*args)¶

Bases: object

ChangeValue()¶

More()¶

Next()¶

Value()¶

property thisown¶: The membership flag

class TNaming_ListOfIndexedDataMapOfShapeListOfShape(*args)¶

Bases: object

Append()¶

Assign()¶

Clear()¶

First()¶

InsertAfter()¶

InsertBefore()¶

Last()¶

Prepend()¶

Remove()¶

RemoveFirst()¶

Reverse()¶

Set()¶

Size()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TNaming_ListOfMapOfShape(*args)¶

Bases: object

Append()¶

Assign()¶

Clear()¶

First()¶

InsertAfter()¶

InsertBefore()¶

Last()¶

Prepend()¶

Remove()¶

RemoveFirst()¶

Reverse()¶

Set()¶

Size()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TNaming_ListOfNamedShape(*args)¶

Bases: object

Append()¶

Assign()¶

Clear()¶

First()¶

InsertAfter()¶

InsertBefore()¶

Last()¶

Prepend()¶

Remove()¶

RemoveFirst()¶

Reverse()¶

Set()¶

Size()¶

begin()¶

cbegin()¶

cend()¶

end()¶

property thisown¶: The membership flag

class TNaming_Localizer(*args)¶

Bases: object

Return type: None

Ancestors()¶

Parameters

S –

type S: TopoDS_Shape
param Type
type Type: TopAbs_ShapeEnum
rtype: TopTools_IndexedDataMapOfShapeListOfShape

Backward()¶

Parameters

NS –

type NS: TNaming_NamedShape
param S
type S: TopoDS_Shape
param Primitives
type Primitives: TNaming_MapOfNamedShape
param ValidShapes
type ValidShapes: TopTools_MapOfShape
rtype: None

FindFeaturesInAncestors()¶

Parameters

S –

type S: TopoDS_Shape
param In
type In: TopoDS_Shape
param AncInFeatures
type AncInFeatures: TopTools_MapOfShape
rtype: None

static FindGenerator()¶

Parameters

NS –

type NS: TNaming_NamedShape
param S
type S: TopoDS_Shape
param theListOfGenerators
type theListOfGenerators: TopTools_ListOfShape
rtype: void

FindNeighbourg()¶

Parameters

Cont –

type Cont: TopoDS_Shape
param S
type S: TopoDS_Shape
param Neighbourg
type Neighbourg: TopTools_MapOfShape
rtype: None

static FindShapeContext()¶

Finds context of the shape <S>.

param NS

type NS

TNaming_NamedShape

param theS

type theS

TopoDS_Shape

param theSC

type theSC

TopoDS_Shape

rtype

void

GoBack()¶

Parameters

S –

type S: TopoDS_Shape
param Lab
type Lab: TDF_Label
param Evol
type Evol: TNaming_Evolution
param OldS
type OldS: TopTools_ListOfShape
param OldLab
type OldLab: TNaming_ListOfNamedShape
rtype: None

Init()¶

Parameters

US –

type US: TNaming_UsedShapes
param CurTrans
type CurTrans: int
rtype: None

static IsNew()¶

Parameters

S –

type S: TopoDS_Shape
param NS
type NS: TNaming_NamedShape
rtype: bool

SubShapes()¶

Parameters

S –

type S: TopoDS_Shape
param Type
type Type: TopAbs_ShapeEnum
rtype: TopTools_MapOfShape

property thisown¶: The membership flag

class TNaming_MapOfNamedShape(*args)¶

Bases: object

Add()¶

Added()¶

Assign()¶

Clear()¶

Contains()¶

Differ()¶

Difference()¶

Exchange()¶

HasIntersection()¶

Intersect()¶

Intersection()¶

IsEqual()¶

ReSize()¶

Remove()¶

Set()¶

Size()¶

Subtract()¶

Subtraction()¶

Union()¶

Unite()¶

cbegin()¶

cend()¶

property thisown¶: The membership flag

class TNaming_MapOfShape(*args)¶

Bases: object

Add()¶

Added()¶

Assign()¶

Clear()¶

Contains()¶

Differ()¶

Difference()¶

Exchange()¶

HasIntersection()¶

Intersect()¶

Intersection()¶

IsEqual()¶

ReSize()¶

Remove()¶

Set()¶

Size()¶

Subtract()¶

Subtraction()¶

Union()¶

Unite()¶

cbegin()¶

cend()¶

property thisown¶: The membership flag

class TNaming_Name(*args)¶

Bases: object

Return type: None

Append()¶

Parameters

arg –

type arg: TNaming_NamedShape
rtype: None

Arguments()¶

Return type: TNaming_ListOfNamedShape

ContextLabel()¶

Parameters

theLab –

type theLab: TDF_Label
rtype: None:rtype: TDF_Label

Index()¶

Parameters

I –

type I: int
rtype: None:rtype: int

Orientation()¶

Parameters

theOrientation –

type theOrientation: TopAbs_Orientation
rtype: None:rtype: TopAbs_Orientation

Paste()¶

Parameters

into –

type into: TNaming_Name
param RT
type RT: TDF_RelocationTable
rtype: None

Shape()¶

Parameters

theShape –

type theShape: TopoDS_Shape
rtype: None:rtype: TopoDS_Shape

ShapeType()¶

Parameters

aType –

type aType: TopAbs_ShapeEnum
rtype: None:rtype: TopAbs_ShapeEnum

Solve()¶

Parameters

aLab –

type aLab: TDF_Label
param Valid
type Valid: TDF_LabelMap
rtype: bool

StopNamedShape()¶

Parameters

arg –

type arg: TNaming_NamedShape
rtype: None:rtype: opencascade::handle<TNaming_NamedShape>

Type()¶

Parameters

aType –

type aType: TNaming_NameType
rtype: None:rtype: TNaming_NameType

property thisown¶: The membership flag

class TNaming_NamedShape(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

Clear()¶

Return type: None

DeltaOnModification()¶

Makes a DeltaOnModification between <self> and <anOldAttribute.

param anOldAttribute

type anOldAttribute

TDF_Attribute

rtype

opencascade::handle<TDF_DeltaOnModification>* Applies a DeltaOnModification to <self>.

param aDelta

type aDelta

TDF_DeltaOnModification

rtype

void

static DownCast(t)¶

DumpToString(TNaming_NamedShape self) → std::string¶

Evolution()¶

Returns the Evolution of the attribute.

rtype

TNaming_Evolution

Get()¶

Returns the shapes contained in <NS>. Returns a null shape if IsEmpty.

rtype

TopoDS_Shape

static GetID()¶

class method ============ Returns the GUID for named shapes.

rtype

Standard_GUID

IsEmpty()¶

Return type: bool

SetVersion()¶

Set the Version of the attribute.

param version

type version

int

rtype

None

Version()¶

Returns the Version of the attribute.

rtype

int

property thisown¶: The membership flag

class TNaming_NamedShapeHasher¶

Bases: object

static HashCode()¶

static IsEqual()¶

property thisown¶: The membership flag

class TNaming_Naming(*args)¶

Bases: OCC.Core.TDF.TDF_Attribute

Return type: None

ChangeName()¶

Return type: TNaming_Name

static DownCast(t)¶

DumpToString(TNaming_Naming self) → std::string¶

static GetID()¶

following code from TDesignStd ==============================

rtype

Standard_GUID

GetName()¶

Return type: TNaming_Name

static Insert()¶

Parameters

under –

type under: TDF_Label
rtype: opencascade::handle<TNaming_Naming>

IsDefined()¶

Return type: bool

static Name()¶

Creates a Namimg attribute at label <where> to identify the shape <Selection>. Geometry is Standard_True if we are only interested by the underlying geometry (e.g. setting a constraint). <Context> is used to find neighbours of <S> when required by the naming. If KeepOrientation is True the Selection orientation is taken into account. BNproblem == True points out that Context sub-shapes in DF have orientation differences with Context shape itself. instance method ===============

param where

type where

TDF_Label

param Selection

type Selection

TopoDS_Shape

param Context

type Context

TopoDS_Shape

param Geometry

default value is Standard_False

type Geometry

bool

param KeepOrientation

default value is Standard_False

type KeepOrientation

bool

param BNproblem

default value is Standard_False

type BNproblem

bool

rtype

opencascade::handle<TNaming_NamedShape>

Regenerate()¶

regenerate only the Name associated to me

param scope

type scope

TDF_LabelMap

rtype

bool

Solve()¶

Regenerate recursively the whole name with scope. If scope is empty it means that all the labels of the framework are valid.

param scope

type scope

TDF_LabelMap

rtype

bool

property thisown¶: The membership flag

class TNaming_NamingTool¶

Bases: object

static BuildDescendants()¶

Parameters

NS –

type NS: TNaming_NamedShape
param Labels
type Labels: TDF_LabelMap
rtype: void

static CurrentShape()¶

Parameters

Valid –

type Valid: TDF_LabelMap
param Forbiden
type Forbiden: TDF_LabelMap
param NS
type NS: TNaming_NamedShape
param MS
type MS: TopTools_IndexedMapOfShape
rtype: void

static CurrentShapeFromShape()¶

Parameters

Valid –

type Valid: TDF_LabelMap
param Forbiden
type Forbiden: TDF_LabelMap
param Acces
type Acces: TDF_Label
param S
type S: TopoDS_Shape
param MS
type MS: TopTools_IndexedMapOfShape
rtype: void

property thisown¶: The membership flag

class TNaming_NewShapeIterator(*args)¶

Bases: object

Parameters

aShape –

type aShape: TopoDS_Shape
param Transaction
type Transaction: int
param access
type access: TDF_Label
rtype: None:param aShape:
type aShape: TopoDS_Shape
param access
type access: TDF_Label
rtype: None* Iterates from the current Shape in <anIterator>
param anIterator
type anIterator: TNaming_NewShapeIterator
rtype: None* Iterates from the current Shape in <anIterator>
param anIterator
type anIterator: TNaming_Iterator
rtype: None

IsModification()¶

True if the new shape is a modification (split, fuse,etc…) of the old shape.

rtype

bool

Label()¶

Return type: TDF_Label

More()¶

Return type: bool

NamedShape()¶

Return type: opencascade::handle<TNaming_NamedShape>

Next()¶

Return type: None

Shape()¶

Warning! Can be a Null Shape if a descendant is deleted.

rtype

TopoDS_Shape

property thisown¶: The membership flag

class TNaming_OldShapeIterator(*args)¶

Bases: object

Parameters

aShape –

type aShape: TopoDS_Shape
param Transaction
type Transaction: int
param access
type access: TDF_Label
rtype: None:param aShape:
type aShape: TopoDS_Shape
param access
type access: TDF_Label
rtype: None* Iterates from the current Shape in <anIterator>
param anIterator
type anIterator: TNaming_OldShapeIterator
rtype: None* Iterates from the current Shape in <anIterator>
param anIterator
type anIterator: TNaming_Iterator
rtype: None

IsModification()¶

True if the new shape is a modification (split, fuse,etc…) of the old shape.

rtype

bool

Label()¶

Return type: TDF_Label

More()¶

Return type: bool

NamedShape()¶

Return type: opencascade::handle<TNaming_NamedShape>

Next()¶

Return type: None

Shape()¶

Return type: TopoDS_Shape

property thisown¶: The membership flag

class TNaming_RefShape(*args)¶

Bases: object

Return type: None:param S: :type S: TopoDS_Shape :rtype: None

FirstUse()¶

Parameters

aPtr –

type aPtr: TNaming_PtrNode
rtype: None:rtype: TNaming_PtrNode

Label()¶

Return type: TDF_Label

NamedShape()¶

Return type: opencascade::handle<TNaming_NamedShape>

Shape()¶

Parameters

S –

type S: TopoDS_Shape
rtype: None:rtype: TopoDS_Shape

property thisown¶: The membership flag

class TNaming_SameShapeIterator(*args)¶

Bases: object

Parameters

aShape –

type aShape: TopoDS_Shape
param access
type access: TDF_Label
rtype: None

Label()¶

Return type: TDF_Label

More()¶

Return type: bool

Next()¶

Return type: None

property thisown¶: The membership flag

class TNaming_Scope(*args)¶

Bases: object

WithValid = False

rtype

None* if <WithValid> the scope is defined by the map. If not on the whole framework.

param WithValid

type WithValid

bool

rtype

None* create a scope with a map. WithValid = True.

param valid

type valid

TDF_LabelMap

rtype

None

ChangeValid()¶

Return type: TDF_LabelMap

ClearValid()¶

Return type: None

CurrentShape()¶

Returns the current value of <NS> according to the Valid Scope.

param NS

type NS

TNaming_NamedShape

rtype

TopoDS_Shape

GetValid()¶

Return type: TDF_LabelMap

IsValid()¶

Parameters

L –

type L: TDF_Label
rtype: bool

Unvalid()¶

Parameters

L –

type L: TDF_Label
rtype: None

UnvalidChildren()¶

Parameters

L –

type L: TDF_Label
param withroot: default value is Standard_True
type withroot: bool
rtype: None

Valid()¶

Parameters

L –

type L: TDF_Label
rtype: None

ValidChildren()¶

Parameters

L –

type L: TDF_Label
param withroot: default value is Standard_True
type withroot: bool
rtype: None

WithValid()¶

Return type: bool:param mode: :type mode: bool :rtype: None

property thisown¶: The membership flag

class TNaming_Selector(*args)¶

Bases: object

Create a selector on this label to select a shape. ==================

param aLabel

type aLabel

TDF_Label

rtype

None

Arguments()¶

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

param args

type args

TDF_AttributeMap

rtype

None

static IsIdentified()¶

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.

param access

type access

TDF_Label

param selection

type selection

TopoDS_Shape

param NS

type NS

TNaming_NamedShape

param Geometry

default value is Standard_False

type Geometry

bool

rtype

bool

NamedShape()¶

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

rtype

opencascade::handle<TNaming_NamedShape>

Select()¶

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.

param Selection

type Selection

TopoDS_Shape

param Context

type Context

TopoDS_Shape

param Geometry

default value is Standard_False

type Geometry

bool

param KeepOrientatation

default value is Standard_False

type KeepOrientatation

bool

rtype

bool* 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.

param Selection

type Selection

TopoDS_Shape

param Geometry

default value is Standard_False

type Geometry

bool

param KeepOrientatation

default value is Standard_False

type KeepOrientatation

bool

rtype

bool

Solve()¶

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

param Valid

type Valid

TDF_LabelMap

rtype

bool

property thisown¶: The membership flag

class TNaming_ShapesSet(*args)¶

Bases: object

Return type: None:param S: :type S: TopoDS_Shape :param Type: default value is TopAbs_SHAPE :type Type: TopAbs_ShapeEnum :rtype: None

Add()¶

Adds the Shape <S>

param S

type S

TopoDS_Shape

rtype

bool* Adds the shapes contained in <Shapes>.

param Shapes

type Shapes

TNaming_ShapesSet

rtype

None

ChangeMap()¶

Return type: TopTools_MapOfShape

Clear()¶

Removes all Shapes

rtype

None

Contains()¶

Returns True if <S> is in <self>

param S

type S

TopoDS_Shape

rtype

bool

Filter()¶

Erases in <self> the shapes not contained in <Shapes>

param Shapes

type Shapes

TNaming_ShapesSet

rtype

None

IsEmpty()¶

Return type: bool

Map()¶

Return type: TopTools_MapOfShape

NbShapes()¶

Return type: int

Remove()¶

Removes <S> in <self>.

param S

type S

TopoDS_Shape

rtype

bool* Removes in <self> the shapes contained in <Shapes>

param Shapes

type Shapes

TNaming_ShapesSet

rtype

None

property thisown¶: The membership flag

class TNaming_Tool¶

Bases: object

static Collect()¶

Parameters

NS –

type NS: TNaming_NamedShape
param Labels
type Labels: TNaming_MapOfNamedShape
param OnlyModif: default value is Standard_True
type OnlyModif: bool
rtype: void

static CurrentNamedShape()¶

Returns the NamedShape of the last Modification of <NS>. This shape is identified by a label.

param NS

type NS

TNaming_NamedShape

param Updated

type Updated

TDF_LabelMap

rtype

opencascade::handle<TNaming_NamedShape>* Returns NamedShape the last Modification of <NS>.

param NS

type NS

TNaming_NamedShape

rtype

opencascade::handle<TNaming_NamedShape>

static CurrentShape()¶

Returns the last Modification of <NS>. Returns the shape CurrentShape contained in the named shape attribute NS. CurrentShape is the current state of the entities if they have been modified in other attributes of the same data structure. Each call to this function creates a new compound.

param NS

type NS

TNaming_NamedShape

rtype

TopoDS_Shape* Returns the shape CurrentShape contained in the named shape attribute NS, and present in the updated attribute map Updated. CurrentShape is the current state of the entities if they have been modified in other attributes of the same data structure. Each call to this function creates a new compound. Warning Only the contents of Updated are searched.R

param NS

type NS

TNaming_NamedShape

param Updated

type Updated

TDF_LabelMap

rtype

TopoDS_Shape

static FindShape()¶

Returns the current shape (a Wire or a Shell) built (in the data framework) from the the shapes of the argument named shape. It is used for IDENTITY name type computation.

param Valid

type Valid

TDF_LabelMap

param Forbiden

type Forbiden

TDF_LabelMap

param Arg

type Arg

TNaming_NamedShape

param S

type S

TopoDS_Shape

rtype

void

static GeneratedShape()¶

Returns the shape generated from S or by a modification of S and contained in the named shape Generation.

param S

type S

TopoDS_Shape

param Generation

type Generation

TNaming_NamedShape

rtype

TopoDS_Shape

static GetShape()¶

Returns the entities stored in the named shape attribute NS. If there is only one old-new pair, the new shape is returned. Otherwise, a Compound is returned. This compound is made out of all the new shapes found. Each call to this function creates a new compound.

param NS

type NS

TNaming_NamedShape

rtype

TopoDS_Shape

static HasLabel()¶

Returns True if <aShape> appears under a label.(DP)

param access

type access

TDF_Label

param aShape

type aShape

TopoDS_Shape

rtype

bool

static InitialShape()¶

Returns the shape created from the shape aShape contained in the attribute anAcces.

param aShape

type aShape

TopoDS_Shape

param anAcces

type anAcces

TDF_Label

param Labels

type Labels

TDF_LabelList

rtype

TopoDS_Shape

static Label()¶

Returns the label of the first apparition of <aShape>. Transdef is a value of the transaction of the first apparition of <aShape>.

param access

type access

TDF_Label

param aShape

type aShape

TopoDS_Shape

param TransDef

type TransDef

int

rtype

TDF_Label

static NamedShape()¶

Returns the named shape attribute defined by the shape aShape and the label anAccess. This attribute is returned as a new shape. You call this function, if you need to create a topological attribute for existing data. Example class MyPkg_MyClass { public: Standard_Boolean SameEdge(const opencascade::handle<OCafTest_Line>& , const opencascade::handle<CafTest_Line>& ); }; //! Standard_Boolean MyPkg_MyClass::SameEdge (const opencascade::handle<OCafTest_Line>& L1 const opencascade::handle<OCafTest_Line>& L2) { opencascade::handle<TNaming_NamedShape> NS1 = L1->NamedShape(); opencascade::handle<TNaming_NamedShape> NS2 = L2->NamedShape(); //! return BRepTools::Compare(NS1->Get(),NS2->Get()); } In the example above, the function SameEdge is created to compare the edges having two lines for geometric supports. If these edges are found by BRepTools::Compare to be within the same tolerance, they are considered to be the same. Warning To avoid sharing of names, a SELECTED attribute will not be returned. Sharing of names makes it harder to manage the data structure. When the user of the name is removed, for example, it is difficult to know whether the name should be destroyed.

param aShape

type aShape

TopoDS_Shape

param anAcces

type anAcces

TDF_Label

rtype

opencascade::handle<TNaming_NamedShape>

static OriginalShape()¶

Returns the shape contained as OldShape in <NS>

param NS

type NS

TNaming_NamedShape

rtype

TopoDS_Shape

static ValidUntil()¶

Returns the last transaction where the creation of S is valid.

param access

type access

TDF_Label

param S

type S

TopoDS_Shape

rtype

int

property thisown¶: The membership flag

class TNaming_TranslateTool¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

Add()¶

Parameters

S1 –

type S1: TopoDS_Shape
param S2
type S2: TopoDS_Shape
rtype: None

static DownCast(t)¶

MakeCompSolid()¶

Parameters

S –

type S: TopoDS_Shape
rtype: None

MakeCompound()¶

Parameters

S –

type S: TopoDS_Shape
rtype: None

MakeEdge()¶

Parameters

S –

type S: TopoDS_Shape
rtype: None

MakeFace()¶

Parameters

S –

type S: TopoDS_Shape
rtype: None

MakeShell()¶

Parameters

S –

type S: TopoDS_Shape
rtype: None

MakeSolid()¶

Parameters

S –

type S: TopoDS_Shape
rtype: None

MakeVertex()¶

Parameters

S –

type S: TopoDS_Shape
rtype: None

MakeWire()¶

Parameters

S –

type S: TopoDS_Shape
rtype: None

UpdateEdge()¶

Parameters

S1 –

type S1: TopoDS_Shape
param S2
type S2: TopoDS_Shape
param M
type M: TColStd_IndexedDataMapOfTransientTransient
rtype: None

UpdateFace()¶

Parameters

S1 –

type S1: TopoDS_Shape
param S2
type S2: TopoDS_Shape
param M
type M: TColStd_IndexedDataMapOfTransientTransient
rtype: None

UpdateShape()¶

Parameters

S1 –

type S1: TopoDS_Shape
param S2
type S2: TopoDS_Shape
rtype: None

UpdateVertex()¶

Parameters

S1 –

type S1: TopoDS_Shape
param S2
type S2: TopoDS_Shape
param M
type M: TColStd_IndexedDataMapOfTransientTransient
rtype: None

property thisown¶: The membership flag

class TNaming_Translator(*args)¶

Bases: object

Return type: None

Add()¶

Parameters

aShape –

type aShape: TopoDS_Shape
rtype: None

Copied()¶

returns copied shape

param aShape

type aShape

TopoDS_Shape

rtype

TopoDS_Shape* returns DataMap of results; (shape <-> copied shape)

rtype

TopTools_DataMapOfShapeShape

DumpMap()¶

Parameters: isWrite – default value is Standard_False :type isWrite: bool :rtype: None

IsDone()¶

Return type: bool

Perform()¶

Return type: None

property thisown¶: The membership flag

class TNaming_UsedShapes(*args, **kwargs)¶

Bases: OCC.Core.TDF.TDF_Attribute

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

Destroy()¶

Return type: None

static DownCast(t)¶

DumpToString(TNaming_UsedShapes self) → std::string¶

static GetID()¶

Returns the ID: 2a96b614-ec8b-11d0-bee7-080009dc3333.

rtype

Standard_GUID

Map()¶

Return type: TNaming_DataMapOfShapePtrRefShape

property thisown¶: The membership flag

class tnaming¶

Bases: object

static ChangeShapes()¶

Remplace les shapes du label et des sous-labels par des copies.

param label

type label

TDF_Label

param M

type M

TopTools_DataMapOfShapeShape

rtype

void

static Displace()¶

Application de la Location sur les shapes du label et de ses sous labels.

param label

type label

TDF_Label

param aLocation

type aLocation

TopLoc_Location

param WithOld

default value is Standard_True

type WithOld

bool

rtype

void

static FindUniqueContext()¶

Find unique context of shape <S>

param S

type S

TopoDS_Shape

param Context

type Context

TopoDS_Shape

rtype

TopoDS_Shape

static FindUniqueContextSet()¶

Find unique context of shape <S>,which is pure concatenation of atomic shapes (Compound). The result is concatenation of single contexts

param S

type S

TopoDS_Shape

param Context

type Context

TopoDS_Shape

param Arr

type Arr

TopTools_HArray1OfShape

rtype

TopoDS_Shape

static IDList()¶

Appends to <anIDList> the list of the attributes IDs of this package. CAUTION: <anIDList> is NOT cleared before use.

param anIDList

type anIDList

TDF_IDList

rtype

void

static MakeShape()¶

Builds shape from map content

param MS

type MS

TopTools_MapOfShape

rtype

TopoDS_Shape

static OuterShell()¶

Returns True if outer Shell is found and the found shell in <theShell>. Print of TNaming enumeration =============================

param theSolid

type theSolid

TopoDS_Solid

param theShell

type theShell

TopoDS_Shell

rtype

bool

static OuterWire()¶

Returns True if outer wire is found and the found wire in <theWire>.

param theFace

type theFace

TopoDS_Face

param theWire

type theWire

TopoDS_Wire

rtype

bool

static Print()¶

Prints the evolution <EVOL> as a String on the Stream <S> and returns <S>.

param EVOL

type EVOL

TNaming_Evolution

param S

type S

Standard_OStream

rtype

Standard_OStream* Prints the name of name type <NAME> as a String on the Stream <S> and returns <S>.

param NAME

type NAME

TNaming_NameType

param S

type S

Standard_OStream

rtype

Standard_OStream* Prints the content of UsedShapes private attribute as a String Table on the Stream <S> and returns <S>.

param ACCESS

type ACCESS

TDF_Label

param S

type S

Standard_OStream

rtype

Standard_OStream

static Replicate()¶

Replicates the named shape with the transformation <T> on the label <L> (and sub-labels if necessary) (TNaming_GENERATED is set)

param NS

type NS

TNaming_NamedShape

param T

type T

gp_Trsf

param L

type L

TDF_Label

rtype

void* Replicates the shape with the transformation <T> on the label <L> (and sub-labels if necessary) (TNaming_GENERATED is set)

param SH

type SH

TopoDS_Shape

param T

type T

gp_Trsf

param L

type L

TDF_Label

rtype

void

static Substitute()¶

Subtituter les shapes sur les structures de source vers cible

param labelsource

type labelsource

TDF_Label

param labelcible

type labelcible

TDF_Label

param mapOldNew

type mapOldNew

TopTools_DataMapOfShapeShape

rtype

void

static SubstituteSShape()¶

Subtitutes shape in source structure

param accesslabel

type accesslabel

TDF_Label

param From

type From

TopoDS_Shape

param To

type To

TopoDS_Shape

rtype

bool

static Transform()¶

Application de la transformation sur les shapes du label et de ses sous labels. Warning: le remplacement du shape est fait dans tous les attributs qui le contiennent meme si ceux ci ne sont pas associees a des sous-labels de <Label>.

param label

type label

TDF_Label

param aTransformation

type aTransformation

gp_Trsf

rtype

void

static Update()¶

Mise a jour des shapes du label et de ses fils en tenant compte des substitutions decrite par mapOldNew. //! Warning: le remplacement du shape est fait dans tous les attributs qui le contiennent meme si ceux ci ne sont pas associees a des sous-labels de <Label>.

param label

type label

TDF_Label

param mapOldNew

type mapOldNew

TopTools_DataMapOfShapeShape

rtype

void

property thisown¶: The membership flag