Open CASCADE Technology  7.3.1.dev
Public Member Functions
ShapeProcess_ShapeContext Class Reference

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

#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. More...
 
void Init (const TopoDS_Shape &S)
 Initializes tool by a new shape and clears all results. More...
 
const TopoDS_ShapeShape () const
 Returns shape being processed. More...
 
const TopoDS_ShapeResult () const
 Returns current result. More...
 
const TopTools_DataMapOfShapeShapeMap () const
 Returns map of replacements shape -> shape This map is not recursive. More...
 
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. More...
 
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. More...
 
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. More...
 
void RecordModification (const TopTools_DataMapOfShapeShape &repl, const Handle< ShapeExtend_MsgRegistrator > &msg=0)
 
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, const Handle< ShapeExtend_MsgRegistrator > &msg=0)
 Records modifications and resets result accordingly NOTE: modification of resulting shape should be explicitly defined in the maps along with modifications of subshapes. More...
 
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. More...
 
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. More...
 
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. More...
 
void PrintStatistics () const
 Prints statistics on Shape Processing onto the current Messenger. More...
 
void SetNonManifold (Standard_Boolean theNonManifold)
 Set NonManifold flag. More...
 
Standard_Boolean IsNonManifold ()
 Get NonManifold flag. More...
 
- Public Member Functions inherited from ShapeProcess_Context
 ShapeProcess_Context ()
 Creates an empty tool. More...
 
 ShapeProcess_Context (const Standard_CString file, const Standard_CString scope="")
 Creates a new tool and initialises by name of resource file and (if specified) starting scope Calls method Init() More...
 
Standard_Boolean Init (const Standard_CString file, const Standard_CString scope="")
 Initialises a tool by loading resource file and (if specified) sets starting scope Returns False if resource file not found. More...
 
Handle< Resource_ManagerLoadResourceManager (const Standard_CString file)
 Loading Resource_Manager object if this object not equal internal static Resource_Manager object or internal static Resource_Manager object is null. More...
 
const Handle< Resource_Manager > & ResourceManager () const
 Returns internal Resource_Manager object. More...
 
void SetScope (const Standard_CString scope)
 Set a new (sub)scope. More...
 
void UnSetScope ()
 Go out of current scope. More...
 
Standard_Boolean IsParamSet (const Standard_CString param) const
 Returns True if parameter is defined in the resource file. More...
 
Standard_Boolean GetReal (const Standard_CString param, Standard_Real &val) const
 
Standard_Boolean GetInteger (const Standard_CString param, Standard_Integer &val) const
 
Standard_Boolean GetBoolean (const Standard_CString param, Standard_Boolean &val) const
 
Standard_Boolean GetString (const Standard_CString param, TCollection_AsciiString &val) const
 Get value of parameter as being of specific type Returns False if parameter is not defined or has a wrong type. More...
 
Standard_Real RealVal (const Standard_CString param, const Standard_Real def) const
 
Standard_Integer IntegerVal (const Standard_CString param, const Standard_Integer def) const
 
Standard_Boolean BooleanVal (const Standard_CString param, const Standard_Boolean def) const
 
Standard_CString StringVal (const Standard_CString param, const Standard_CString def) const
 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. More...
 
void SetMessenger (const Handle< Message_Messenger > &messenger)
 Sets Messenger used for outputting messages. More...
 
Handle< Message_MessengerMessenger () const
 Returns Messenger used for outputting messages. More...
 
void SetProgress (const Handle< Message_ProgressIndicator > &theProgress)
 Sets Progress Indicator. More...
 
Handle< Message_ProgressIndicatorProgress () const
 Returns Progress Indicator. More...
 
void SetTraceLevel (const Standard_Integer tracelev)
 Sets trace level used for outputting messages. More...
 
Standard_Integer TraceLevel () const
 Returns trace level used for outputting messages. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ShapeProcess_ShapeContext() [1/2]

ShapeProcess_ShapeContext::ShapeProcess_ShapeContext ( const Standard_CString  file,
const Standard_CString  seq = "" 
)

◆ ShapeProcess_ShapeContext() [2/2]

ShapeProcess_ShapeContext::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.

Member Function Documentation

◆ AddMessage()

void ShapeProcess_ShapeContext::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.

◆ ContinuityVal()

GeomAbs_Shape ShapeProcess_ShapeContext::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.

◆ GetContinuity()

Standard_Boolean ShapeProcess_ShapeContext::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.

◆ GetDetalisation()

TopAbs_ShapeEnum ShapeProcess_ShapeContext::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.

◆ Init()

void ShapeProcess_ShapeContext::Init ( const TopoDS_Shape S)

Initializes tool by a new shape and clears all results.

◆ IsNonManifold()

Standard_Boolean ShapeProcess_ShapeContext::IsNonManifold ( )
inline

Get NonManifold flag.

◆ Map()

const TopTools_DataMapOfShapeShape& ShapeProcess_ShapeContext::Map ( ) const

Returns map of replacements shape -> shape This map is not recursive.

◆ Messages() [1/2]

const Handle< ShapeExtend_MsgRegistrator >& ShapeProcess_ShapeContext::Messages ( ) const

◆ Messages() [2/2]

Handle< ShapeExtend_MsgRegistrator >& ShapeProcess_ShapeContext::Messages ( )

Returns messages recorded during shape processing It can be nullified before processing in order to avoid recording messages.

◆ PrintStatistics()

void ShapeProcess_ShapeContext::PrintStatistics ( ) const

Prints statistics on Shape Processing onto the current Messenger.

◆ RecordModification() [1/4]

void ShapeProcess_ShapeContext::RecordModification ( const TopTools_DataMapOfShapeShape repl,
const Handle< ShapeExtend_MsgRegistrator > &  msg = 0 
)

◆ RecordModification() [2/4]

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

◆ RecordModification() [3/4]

void ShapeProcess_ShapeContext::RecordModification ( const Handle< ShapeBuild_ReShape > &  repl)

◆ RecordModification() [4/4]

void ShapeProcess_ShapeContext::RecordModification ( const TopoDS_Shape sh,
const BRepTools_Modifier repl,
const Handle< ShapeExtend_MsgRegistrator > &  msg = 0 
)

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

◆ Result()

const TopoDS_Shape& ShapeProcess_ShapeContext::Result ( ) const

Returns current result.

◆ SetDetalisation()

void ShapeProcess_ShapeContext::SetDetalisation ( const TopAbs_ShapeEnum  level)

◆ SetNonManifold()

void ShapeProcess_ShapeContext::SetNonManifold ( Standard_Boolean  theNonManifold)
inline

Set NonManifold flag.

◆ SetResult()

void ShapeProcess_ShapeContext::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.

◆ Shape()

const TopoDS_Shape& ShapeProcess_ShapeContext::Shape ( ) const

Returns shape being processed.


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