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:

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_Shape &	Shape () const
	Returns shape being processed More...

const TopoDS_Shape &	Result () const
	Returns current result More...

const TopTools_DataMapOfShapeShape &	Map () 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)

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 <br> NOTE: modification of resulting shape should be explicitly <br> defined in the maps along with modifications of subshapes <br> 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 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...

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_Manager	LoadResourceManager (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_Messenger	Messenger () const
	Returns Messenger used for outputting messages. More...

void	SetProgress (const Handle< Message_ProgressIndicator > &theProgress)
	Sets Progress Indicator. More...

Handle_Message_ProgressIndicator	Progress () 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 MMgt_TShared
virtual void	Delete () const
	Memory deallocator for transient classes. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const 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 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...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

Detailed Description

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

Constructor & Destructor Documentation

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

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

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

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

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

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

void ShapeProcess_ShapeContext::Init ( const TopoDS_Shape & S )

Initializes tool by a new shape and clears all results

const TopTools_DataMapOfShapeShape& ShapeProcess_ShapeContext::Map ( ) const

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

const Handle_ShapeExtend_MsgRegistrator& ShapeProcess_ShapeContext::Messages ( ) const

Handle_ShapeExtend_MsgRegistrator& ShapeProcess_ShapeContext::Messages ( )

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

void ShapeProcess_ShapeContext::PrintStatistics ( ) const

Prints statistics on Shape Processing onto the current Messenger.

void ShapeProcess_ShapeContext::RecordModification ( const TopTools_DataMapOfShapeShape & repl )

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

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

void ShapeProcess_ShapeContext::RecordModification	(	const TopoDS_Shape &	sh,
		const BRepTools_Modifier &	repl
	)

 Records modifications and resets result accordingly <br>
     NOTE: modification of resulting shape should be explicitly <br>
     defined in the maps along with modifications of subshapes <br>

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

const TopoDS_Shape& ShapeProcess_ShapeContext::Result ( ) const

Returns current result

void ShapeProcess_ShapeContext::SetDetalisation ( const TopAbs_ShapeEnum level )

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

const TopoDS_Shape& ShapeProcess_ShapeContext::Shape ( ) const

Returns shape being processed

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

ShapeProcess_ShapeContext.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation