ModuleBase_ResultPrs Class Reference

A redefinition of standard AIS Interactive Object in order to provide specific behaviour for wire presentations based in a one plane. More...

#include <ModuleBase_ResultPrs.h>

Inheritance diagram for ModuleBase_ResultPrs:

Public Types
enum	SelectionModes { Sel_Result = TopAbs_SHAPE + 1 }

Public Member Functions
	ModuleBase_ResultPrs (ResultPtr theResult)
	Constructor. More...
virtual void	HilightSelected (const Handle &thePM, const SelectMgr_SequenceOfOwner &theOwners)
	Method which draws selected owners ( for fast presentation draw ) More...
virtual void	HilightOwnerWithColor (const Handle &thePM, const Handle &theStyle, const Handle &theOwner)
	Method which highlight an owner belonging to this selectable object ( for fast presentation draw ) More...
ResultPtr	getResult () const
	Returns result object. More...
int	getAdditionalSelectionPriority () const
	Returns selection priorities that will be added to created selection owner. More...
void	setAdditionalSelectionPriority (const int thePriority)
	Appends a special priority for the mode of selection. More...
virtual void	SetColor (const Quantity_Color &theColor)
	Updates color of sub shape drawer. More...
void	setSubShapeHidden (const TopoDS_ListOfShape &theShapes)
	Change presentation to have given shape hidden. More...
bool	isSubShapeHidden (const TopoDS_Shape &theShape)
	Returns true if parameter shape has been hidden. More...
const TopoDS_ListOfShape &	hiddenSubShapes () const
	Returns hidden sub shapes list. More...
bool	hasSubShapeVisible (const TopoDS_ListOfShape &theShapesToSkip)
	Returns true if there are no hidden sub shapes or original shape has at least one not hidden. More...
bool	setHiddenSubShapeTransparency (double theTransparency)
	Set transparency of hidden sub shapes: if value is 1, shapes are entirely hidden. More...
TopoDS_Shape	originalShape () const
	Returns the original shape of the presentation. More...
bool	isSubstituted () const
	Returns True if the original shape is substituted by a corresponded shell. More...
void	updateIsoLines ()
virtual DEFINE_STANDARD_RTTIEXT(ModuleBase_ResultPrs, ViewerData_AISShape) protected void	ComputeSelection (const Handle &aSelection, const Standard_Integer theMode)
	Redefinition of virtual function. More...

Detailed Description

A redefinition of standard AIS Interactive Object in order to provide specific behaviour for wire presentations based in a one plane.

Constructor & Destructor Documentation

ModuleBase_ResultPrs()

ModuleBase_ResultPrs::ModuleBase_ResultPrs

(

ResultPtr

theResult

)

Constructor.

Parameters

theResult

a result object

Member Function Documentation

HilightSelected()

void ModuleBase_ResultPrs::HilightSelected ( const Handle &  thePM, const SelectMgr_SequenceOfOwner &  theOwners  )

virtual

Method which draws selected owners ( for fast presentation draw )

HilightOwnerWithColor()

void ModuleBase_ResultPrs::HilightOwnerWithColor ( const Handle &  thePM, const Handle &  theStyle, const Handle &  theOwner  )

virtual

Method which highlight an owner belonging to this selectable object ( for fast presentation draw )

getResult()

ResultPtr ModuleBase_ResultPrs::getResult ( ) const

inline

Returns result object.

getAdditionalSelectionPriority()

int ModuleBase_ResultPrs::getAdditionalSelectionPriority ( ) const

inline

Returns selection priorities that will be added to created selection owner.

Returns

integer value

setAdditionalSelectionPriority()

void ModuleBase_ResultPrs::setAdditionalSelectionPriority

(

const int

thePriority

)

Appends a special priority for the mode of selection.

Parameters

theSelectionMode	a mode of selection, used in ComputeSelection
thePriority	a new priority value

SetColor()

void ModuleBase_ResultPrs::SetColor ( const Quantity_Color &  theColor )

virtual

Updates color of sub shape drawer.

setSubShapeHidden()

void ModuleBase_ResultPrs::setSubShapeHidden

(

const TopoDS_ListOfShape &

theShapes

)

Change presentation to have given shape hidden.

It supports FACE type of the shape to be hidden. If presentation type is greater than FACE, the SHELL with be shown with the FACE hidden It is possible to hide more than one FACE by calling the method with given FACES Visual state of the face is controlled by the second parameter

Parameters

theShapes

a container of shape objects

Returns

true if the presentation is changed, or false (if for example it was hidden)

isSubShapeHidden()

bool ModuleBase_ResultPrs::isSubShapeHidden

(

const TopoDS_Shape &

theShape

)

Returns true if parameter shape has been hidden.

Parameters

theShape

sub-shape of the presentation shape

Returns

boolean value

hiddenSubShapes()

const TopoDS_ListOfShape & ModuleBase_ResultPrs::hiddenSubShapes ( ) const

inline

Returns hidden sub shapes list.

hasSubShapeVisible()

bool ModuleBase_ResultPrs::hasSubShapeVisible

(

const TopoDS_ListOfShape &

theShapesToSkip

)

Returns true if there are no hidden sub shapes or original shape has at least one not hidden.

Parameters

theShapesToSkip

container of shape to be hidden in the presentation (faces)

Returns

boolean value

setHiddenSubShapeTransparency()

bool ModuleBase_ResultPrs::setHiddenSubShapeTransparency

(

double

theTransparency

)

Set transparency of hidden sub shapes: if value is 1, shapes are entirely hidden.

Parameters

theTransparency

transparency value

Returns

false if parameter is out of [0, 1]

originalShape()

TopoDS_Shape ModuleBase_ResultPrs::originalShape ( ) const

inline

Returns the original shape of the presentation.

isSubstituted()

bool ModuleBase_ResultPrs::isSubstituted ( ) const

inline

Returns True if the original shape is substituted by a corresponded shell.

ComputeSelection()

void ModuleBase_ResultPrs::ComputeSelection ( const Handle &  aSelection, const Standard_Integer  theMode  )

virtual

Redefinition of virtual function.