ShapeProcess

OCCT package ShapeProcess: ShapeProcess, ShapeProcess_Context, ShapeProcess_Operator, ShapeProcess_OperLibrary, and 2 more bound classes.

Shape Processing module allows to define and apply general Shape Processing as a customizable sequence of Shape Healing operators. The customization is implemented via user-editable resource file which defines sequence of operators to be executed and their parameters.

Constructors(1)

constructor(): ShapeProcess

Static methods(5)

RegisterOperator(name: string, op: ShapeProcess_Operator): boolean
Registers operator to make it visible for Performer.
Parameters (2)
- name
- op
FindOperator(name: string): { returnValue: boolean; op: ShapeProcess_Operator; [Symbol.dispose](): void }
Finds operator by its name.
Parameters (1)
- name
Returns
A result object with fields:
- returnValue: the C++ return value
- op: owned by the returned envelope.
  Dispose the returned envelope to release owned Handle fields.
Perform(context: ShapeProcess_Context, seq: string, theProgress: Message_ProgressRange): boolean
Performs a specified sequence of operators on theContext.
Parameters (3)
- context
- seq
- theProgress —
  Progress indicator.
Returns
true if at least one operation was performed, false otherwise.
Perform(theContext: ShapeProcess_Context, theOperations: any, theProgress: Message_ProgressRange): boolean
Performs a specified sequence of operators on theContext.
Parameters (3)
- theContext —
  Context to perform operations on. Contains the shape to process and processing parameters. If processing parameters are not set, default values are used. Parameters should be in a scope of operation, for example, instead of "FromSTEP.FixShape.Tolerance3d" we should use just "FixShape.Tolerance3d".
- theOperations —
  Bitset of operations to perform.
- theProgress —
  Progress indicator.
Returns
true if at least one operation was performed, false otherwise.
ToOperationFlag(theName: string): [ShapeProcess_Operation, boolean]
Converts operation name to operation flag.
Parameters (1)
- theName —
  Operation name.
Returns
Operation flag and true if the operation name is valid, false otherwise.

ShapeProcess_Context

Standard_Transient

Provides convenient interface to resource file Allows to load resource file and get values of attributes starting from some scope, for example if scope is defined as "ToV4" and requested parameter is "exec.op", value of "ToV4.exec.op" parameter from the resource file will be returned.

Constructors(2)

constructor(): ShapeProcess_Context
Creates an empty tool.
constructor(file: string, scope?: string): ShapeProcess_Context
Creates a new tool and initialises by name of resource file and (if specified) starting scope Calls method Init().
Parameters (2)
- file
- scope

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(16)

LoadResourceManager(file: string): Resource_Manager
Loading Resource_Manager object if this object not equal internal static Resource_Manager object or internal static Resource_Manager object is null.
Parameters (1)
- file
ResourceManager(): Resource_Manager
Returns internal Resource_Manager object.
SetScope(scope: string): void
Set a new (sub)scope.
Parameters (1)
- scope
UnSetScope(): void
Go out of current scope.
IsParamSet(param: string): boolean
Returns True if parameter is defined in the resource file.
Parameters (1)
- param
GetReal(param: string, val: number): { returnValue: boolean; val: number }
Parameters (2)
- param
- val
GetInteger(param: string, val: number): { returnValue: boolean; val: number }
Parameters (2)
- param
- val
GetBoolean(param: string, val: boolean): { returnValue: boolean; val: boolean }
Parameters (2)
- param
- val
GetString(param: string, val: TCollection_AsciiString): boolean
Get value of parameter as being of specific type Returns False if parameter is not defined or has a wrong type.
Parameters (2)
- param
- val —
  Mutated in place; read the updated value from this argument after the call.
RealVal(param: string, def: number): number
Parameters (2)
- param
- def
IntegerVal(param: string, def: number): number
Parameters (2)
- param
- def
BooleanVal(param: string, def: boolean): boolean
Parameters (2)
- param
- def
StringVal(param: string, def: string): string
Get value of parameter as being of specific type If parameter is not defined or does not have expected type, returns default value as specified.
Parameters (2)
- param
- def
SetTraceLevel(tracelev: number): void
Sets trace level used for outputting messages.
- 0: no trace at all
- 1: errors
- 2: errors and warnings
- 3: all messages Default is 1 : Errors traced
Parameters (1)
- tracelev
TraceLevel(): number
Returns trace level used for outputting messages.
DynamicType(): Standard_Type

ShapeProcess_Operator

Standard_Transient

Abstract Operator class providing a tool to perform an operation on Context.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

Perform(context: ShapeProcess_Context, theProgress?: Message_ProgressRange): boolean
Performs operation and eventually records changes in the context.
Parameters (2)
- context
- theProgress
DynamicType(): Standard_Type

ShapeProcess_OperLibrary

Provides a set of following operators.
DirectFaces FixShape SameParameter SetTolerance SplitAngle BSplineRestriction ElementaryToRevolution SurfaceToBSpline ToBezier SplitContinuity SplitClosedFaces FixWireGaps FixFaceSize DropSmallEdges FixShape SplitClosedEdges

Constructors(1)

constructor(): ShapeProcess_OperLibrary

Static methods(2)

Init(): void
Registers all the operators.
ApplyModifier(S: TopoDS_Shape, context: ShapeProcess_ShapeContext, M: BRepTools_Modification, map: NCollection_DataMap_TopoDS_Shape_TopoDS_Shape_TopTools_ShapeMapHasher, msg: ShapeExtend_MsgRegistrator, theMutableInput: boolean): TopoDS_Shape
Applies BRepTools_Modification to a shape, taking into account sharing of components of compounds. if theMutableInput vat is set to true then input shape S can be modified during the modification process.
Parameters (6)
- S
- context
- M
- map —
  Mutated in place; read the updated value from this argument after the call.
- msg
- theMutableInput

ShapeProcess_ShapeContext

ShapeProcess_ContextStandard_Transient

Extends Context to handle shapes Contains map of shape-shape, and messages attached to shapes.

Constructors(2)

constructor(file: string, seq?: string): ShapeProcess_ShapeContext
Parameters (2)
- file
- seq
constructor(S: TopoDS_Shape, file: string, seq?: string): ShapeProcess_ShapeContext
Initializes a tool by resource file and shape to be processed.
Parameters (3)
- S
- file
- seq

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(20)

Init(S: TopoDS_Shape): void
Initializes tool by a new shape and clears all results.
Parameters (1)
- S
Init(file: string, scope: string): boolean
Initializes tool by a new shape and clears all results.
Parameters (2)
- file
- scope
Shape(): TopoDS_Shape
Returns shape being processed.
Result(): TopoDS_Shape
Returns current result.
Map(): NCollection_DataMap_TopoDS_Shape_TopoDS_Shape_TopTools_ShapeMapHasher
Returns map of replacements shape -> shape This map is not recursive.
Messages(): ShapeExtend_MsgRegistrator
SetDetalisation(level: TopAbs_ShapeEnum): void
Parameters (1)
- level
GetDetalisation(): TopAbs_ShapeEnum
Set and get value for detalisation level Only shapes of types from TopoDS_COMPOUND and until specified detalisation level will be recorded in maps To cancel mapping, use TopAbs_SHAPE To force full mapping, use TopAbs_VERTEX The default level is TopAbs_FACE.
SetResult(S: TopoDS_Shape): void
Sets a new result shape NOTE: this method should be used very carefully to keep consistency of modifications It is recommended to use RecordModification() methods with explicit definition of mapping from current result to a new one.
Parameters (1)
- S
RecordModification(repl: ShapeBuild_ReShape): void
Parameters (1)
- repl
RecordModification(repl: NCollection_DataMap_TopoDS_Shape_TopoDS_Shape_TopTools_ShapeMapHasher, msg: ShapeExtend_MsgRegistrator): void
Parameters (2)
- repl
- msg
RecordModification(repl: ShapeBuild_ReShape, msg: ShapeExtend_MsgRegistrator): void
Parameters (2)
- repl
- msg
RecordModification(sh: TopoDS_Shape, repl: BRepTools_Modifier, msg: ShapeExtend_MsgRegistrator): void
Records modifications and resets result accordingly NOTE: modification of resulting shape should be explicitly defined in the maps along with modifications of subshapes.
In the last function, sh is the shape on which Modifier was run. It can be different from the whole shape, but in that case result as a whole should be reset later either by call to SetResult(), or by another call to RecordModification() which contains mapping of current result to a new one explicitly
Parameters (3)
- sh
- repl
- msg
AddMessage(S: TopoDS_Shape, msg: Message_Msg, gravity?: Message_Gravity): void
Record a message for shape S Shape S should be one of subshapes of original shape (or whole one), but not one of intermediate shapes Records only if Message() is not Null.
Parameters (3)
- S
- msg
- gravity
GetContinuity(param: string, val: GeomAbs_Shape): { returnValue: boolean; val: GeomAbs_Shape }
Get value of parameter as being of the type GeomAbs_Shape Returns False if parameter is not defined or has a wrong type.
Parameters (2)
- param
- val
Returns
A result object with fields:
- returnValue: the C++ return value
- val: updated value from the call.
ContinuityVal(param: string, def: GeomAbs_Shape): GeomAbs_Shape
Get value of parameter as being of the type GeomAbs_Shape If parameter is not defined or does not have expected type, returns default value as specified.
Parameters (2)
- param
- def
PrintStatistics(): void
Prints statistics on Shape Processing onto the current Messenger.
SetNonManifold(theNonManifold: boolean): void
Set NonManifold flag.
Parameters (1)
- theNonManifold
IsNonManifold(): boolean
Get NonManifold flag.
DynamicType(): Standard_Type

ShapeProcess_UOperator

ShapeProcess_OperatorStandard_Transient

Defines operator as container for static function OperFunc. This allows user to create new operators without creation of new classes.

Constructors(1)

constructor(func: ((arg0: ShapeProcess_Context, arg1: Message_ProgressRange)): ShapeProcess_UOperator
Creates operator with implementation defined as OperFunc (static function).
Parameters (1)
- func

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

Perform(context: ShapeProcess_Context, theProgress?: Message_ProgressRange): boolean
Performs operation and records changes in the context.
Parameters (2)
- context
- theProgress
DynamicType(): Standard_Type