OCC Main Page | ModelingAlgorithms | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingAlgorithms
TKShHealing
ShapeProcess


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

Standard_EXPORT ShapeProcess_ShapeContext (const Standard_CString file, const Standard_CString seq="")
Standard_EXPORT 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
.
Standard_EXPORT void Init (const TopoDS_Shape &S)
 Initializes tool by a new shape and clears all results
.
Standard_EXPORT const TopoDS_Shape & Shape () const
 Returns shape being processed
.
Standard_EXPORT const TopoDS_Shape & Result () const
 Returns current result
.
Standard_EXPORT const TopTools_DataMapOfShapeShape & Map () const
 Returns map of replacements shape -> shape
This map is not recursive
.
Standard_EXPORT const Handle_ShapeExtend_MsgRegistrator & Messages () const
Standard_EXPORT Handle_ShapeExtend_MsgRegistrator & Messages ()
 Returns messages recorded during shape processing
It can be nullified before processing in order to
avoid recording messages
.
Standard_EXPORT void SetDetalisation (const TopAbs_ShapeEnum level)
Standard_EXPORT 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
.
Standard_EXPORT 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
.
Standard_EXPORT void RecordModification (const TopTools_DataMapOfShapeShape &repl)
Standard_EXPORT void RecordModification (const Handle(ShapeBuild_ReShape)&repl, const Handle(ShapeExtend_MsgRegistrator)&msg)
Standard_EXPORT void RecordModification (const Handle(ShapeBuild_ReShape)&repl)
Standard_EXPORT 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
.
Standard_EXPORT 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_EXPORT 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
.
Standard_EXPORT 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
.
Standard_EXPORT void PrintStatistics () const
 Prints statistics on Shape Processing onto the current Messenger.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

TopoDS_Shape myShape
TopoDS_Shape myResult
TopTools_DataMapOfShapeShape myMap
Handle_ShapeExtend_MsgRegistrator myMsg
TopAbs_ShapeEnum myUntil

Constructor & Destructor Documentation

Standard_EXPORT ShapeProcess_ShapeContext::ShapeProcess_ShapeContext const Standard_CString  file,
const Standard_CString  seq = ""
 

Standard_EXPORT ShapeProcess_ShapeContext::ShapeProcess_ShapeContext const TopoDS_Shape &  S,
const Standard_CString  file,
const Standard_CString  seq = ""
 


Member Function Documentation

Standard_EXPORT void ShapeProcess_ShapeContext::AddMessage const TopoDS_Shape &  S,
const Message_Msg &  msg,
const Message_Gravity  gravity = Message_Warning
 

Standard_EXPORT GeomAbs_Shape ShapeProcess_ShapeContext::ContinuityVal const Standard_CString  param,
const GeomAbs_Shape  def
const
 

Standard_EXPORT Standard_Boolean ShapeProcess_ShapeContext::GetContinuity const Standard_CString  param,
GeomAbs_Shape &  val
const
 

Standard_EXPORT TopAbs_ShapeEnum ShapeProcess_ShapeContext::GetDetalisation  )  const
 

Standard_EXPORT const ShapeProcess_ShapeContext::Handle Standard_Type   )  const
 

Reimplemented from ShapeProcess_Context.

Standard_EXPORT void ShapeProcess_ShapeContext::Init const TopoDS_Shape &  S  ) 
 

Standard_EXPORT const TopTools_DataMapOfShapeShape& ShapeProcess_ShapeContext::Map  )  const
 

Standard_EXPORT Handle_ShapeExtend_MsgRegistrator& ShapeProcess_ShapeContext::Messages  ) 
 

Standard_EXPORT const Handle_ShapeExtend_MsgRegistrator& ShapeProcess_ShapeContext::Messages  )  const
 

Standard_EXPORT void ShapeProcess_ShapeContext::PrintStatistics  )  const
 

Standard_EXPORT void ShapeProcess_ShapeContext::RecordModification const TopoDS_Shape &  sh,
const BRepTools_Modifier &  repl
 

Standard_EXPORT void ShapeProcess_ShapeContext::RecordModification const Handle(ShapeBuild_ReShape)&  repl  ) 
 

Standard_EXPORT void ShapeProcess_ShapeContext::RecordModification const Handle(ShapeBuild_ReShape)&  repl,
const Handle(ShapeExtend_MsgRegistrator)&  msg
 

Standard_EXPORT void ShapeProcess_ShapeContext::RecordModification const TopTools_DataMapOfShapeShape &  repl  ) 
 

Standard_EXPORT const TopoDS_Shape& ShapeProcess_ShapeContext::Result  )  const
 

Standard_EXPORT void ShapeProcess_ShapeContext::SetDetalisation const TopAbs_ShapeEnum  level  ) 
 

Standard_EXPORT void ShapeProcess_ShapeContext::SetResult const TopoDS_Shape &  S  ) 
 

Standard_EXPORT const TopoDS_Shape& ShapeProcess_ShapeContext::Shape  )  const
 


Field Documentation

TopTools_DataMapOfShapeShape ShapeProcess_ShapeContext::myMap [private]
 

Handle_ShapeExtend_MsgRegistrator ShapeProcess_ShapeContext::myMsg [private]
 

TopoDS_Shape ShapeProcess_ShapeContext::myResult [private]
 

TopoDS_Shape ShapeProcess_ShapeContext::myShape [private]
 

TopAbs_ShapeEnum ShapeProcess_ShapeContext::myUntil [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:42:42 2008 for OpenCASCADE by  doxygen 1.4.1