Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
ShapeProcess_ShapeContext Class Reference

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

#include <ShapeProcess_ShapeContext.hxx>

Inheritance diagram for ShapeProcess_ShapeContext:
Inheritance graph
[legend]

Public Member Functions

 ShapeProcess_ShapeContext (const Standard_CString file, const Standard_CString seq="")
 ShapeProcess_ShapeContext (const TopoDS_Shape &S, const Standard_CString file, const Standard_CString seq="")
 Initializes a tool by resource file and shape
to be processed

void Init (const TopoDS_Shape &S)
 Initializes tool by a new shape and clears all results

const TopoDS_ShapeShape () const
 Returns shape being processed

const TopoDS_ShapeResult () const
 Returns current result

const
TopTools_DataMapOfShapeShape
Map () const
 Returns map of replacements shape -> shape
This map is not recursive

const
Handle_ShapeExtend_MsgRegistrator & 
Messages () const
Handle_ShapeExtend_MsgRegistrator & Messages ()
 Returns messages recorded during shape processing
It can be nullified before processing in order to
avoid recording messages

void SetDetalisation (const TopAbs_ShapeEnum level)
TopAbs_ShapeEnum GetDetalisation () const
 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

void SetResult (const TopoDS_Shape &S)
 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

void RecordModification (const TopTools_DataMapOfShapeShape &repl)
void RecordModification (const Handle< ShapeBuild_ReShape > &repl, const Handle< ShapeExtend_MsgRegistrator > &msg)
void RecordModification (const Handle< ShapeBuild_ReShape > &repl)
void RecordModification (const TopoDS_Shape &sh, const BRepTools_Modifier &repl)
 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

void AddMessage (const TopoDS_Shape &S, const Message_Msg &msg, const Message_Gravity gravity=Message_Warning)
 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

Standard_Boolean GetContinuity (const Standard_CString param, GeomAbs_Shape &val) const
 Get value of parameter as being of the type GeomAbs_Shape
Returns False if parameter is not defined or has a wrong type

GeomAbs_Shape ContinuityVal (const Standard_CString param, const GeomAbs_Shape def) const
 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

void PrintStatistics () const
 Prints statistics on Shape Processing onto the current Messenger.


Constructor & Destructor Documentation


Member Function Documentation

const Handle_ShapeExtend_MsgRegistrator& ShapeProcess_ShapeContext::Messages ( ) const
Handle_ShapeExtend_MsgRegistrator& ShapeProcess_ShapeContext::Messages ( )

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