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

Visualization
TKV3d
StdSelect


StdSelect_BRepOwner Class Reference

Defines Specific Owners for Sensitive Primitives
(Sensitive Segments,Circles...).
Used in Dynamic Selection Mechanism.
A BRepOwner has an Owner (the shape it represents)
and Users (One or More Transient entities).
.

#include <StdSelect_BRepOwner.hxx>

Inheritance diagram for StdSelect_BRepOwner:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT StdSelect_BRepOwner (const Standard_Integer aPriority)
 Constructs an owner specification framework defined
by the priority aPriority.
.
Standard_EXPORT StdSelect_BRepOwner (const TopoDS_Shape &aShape, const Standard_Integer aPriority=0, const Standard_Boolean ComesFromDecomposition=Standard_False)
 Constructs an owner specification framework defined
by the shape aShape and the priority aPriority.
aShape and aPriority are stored in this framework. If
more than one owner are detected during dynamic
selection, the one with the highest priority is the one stored.
.
Standard_EXPORT StdSelect_BRepOwner (const TopoDS_Shape &aShape, const Handle(SelectMgr_SelectableObject)&theOrigin, const Standard_Integer aPriority=0, const Standard_Boolean FromDecomposition=Standard_False)
 Constructs an owner specification framework defined
by the shape aShape, the selectable object theOrigin
and the priority aPriority.
aShape, theOrigin and aPriority are stored in this
framework. If more than one owner are detected
during dynamic selection, the one with the highest
priority is the one stored.
.
Standard_Boolean HasShape () const
 returns False if no shape was set


Standard_EXPORT void Set (const TopoDS_Shape &aShape, const Standard_Boolean FromDecomposition=Standard_False)
 <fromdecomposition> indicates whether <ashape>
comes from decomposition of a bigger shape.

Standard_Boolean ComesFromDecomposition () const
const TopoDS_Shape & Shape () const
Standard_Boolean HasHilightMode () const
 Returns true if this framework has a highlight mode defined for it.
.
void SetHilightMode (const Standard_Integer aMode)
 Sets the highlight mode for this framework.
This defines the type of display used to highlight the
owner of the shape when it is detected by the selector.
The default type of display is wireframe, defined by the index 0.
.
void ResetHilightMode ()
 Resets the higlight mode for this framework.
This defines the type of display used to highlight the
owner of the shape when it is detected by the selector.
The default type of display is wireframe, defined by the index 0.
.
Standard_Integer HilightMode () const
 Returns the highlight mode for this framework.
This defines the type of display used to highlight the
owner of the shape when it is detected by the selector.
The default type of display is wireframe, defined by the index 0.
.
virtual Standard_EXPORT Standard_Boolean IsHilighted (const Handle(PrsMgr_PresentationManager)&aPM, const Standard_Integer aMode=0) const
 Returns true if an object with the selection mode
aMode is highlighted in the presentation manager aPM.
.
virtual Standard_EXPORT void Hilight ()
 Provides a framework to highlight any selectable
object found subsequently which can serve as an
owner of a sensitive primitive.
.
virtual Standard_EXPORT void Hilight (const Handle(PrsMgr_PresentationManager)&aPM, const Standard_Integer aMode=0)
 Returns the selection mode aMode defining the type
of shape highlighted in the presentation manager aPM.
.
virtual Standard_EXPORT void HilightWithColor (const Handle(PrsMgr_PresentationManager3d)&aPM, const Quantity_NameOfColor aCol, const Standard_Integer aMode=0)
virtual Standard_EXPORT void Unhilight (const Handle(PrsMgr_PresentationManager)&aPM, const Standard_Integer aMode=0)
 Removes highlighting from the type of shape
identified the selection mode aMode in the presentation manager aPM.
.
virtual Standard_EXPORT void Clear (const Handle(PrsMgr_PresentationManager)&aPM, const Standard_Integer aMode=0)
 Clears the presentation manager object aPM of all
shapes with the selection mode aMode.
.
virtual Standard_EXPORT void SetLocation (const TopLoc_Location &aLoc)
virtual Standard_EXPORT void ResetLocation ()
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Protected Attributes

Standard_Boolean myFromDecomposition
TopoDS_Shape myShape

Private Attributes

Handle_StdSelect_Shape myPrsSh
Standard_Integer myCurMode

Constructor & Destructor Documentation

Standard_EXPORT StdSelect_BRepOwner::StdSelect_BRepOwner const Standard_Integer  aPriority  ) 
 

Standard_EXPORT StdSelect_BRepOwner::StdSelect_BRepOwner const TopoDS_Shape &  aShape,
const Standard_Integer  aPriority = 0,
const Standard_Boolean  ComesFromDecomposition = Standard_False
 

Standard_EXPORT StdSelect_BRepOwner::StdSelect_BRepOwner const TopoDS_Shape &  aShape,
const Handle(SelectMgr_SelectableObject)&  theOrigin,
const Standard_Integer  aPriority = 0,
const Standard_Boolean  FromDecomposition = Standard_False
 


Member Function Documentation

virtual Standard_EXPORT void StdSelect_BRepOwner::Clear const Handle(PrsMgr_PresentationManager)&  aPM,
const Standard_Integer  aMode = 0
[virtual]
 

Reimplemented from SelectMgr_EntityOwner.

Standard_Boolean StdSelect_BRepOwner::ComesFromDecomposition  )  const [inline]
 

Standard_EXPORT const StdSelect_BRepOwner::Handle Standard_Type   )  const
 

Reimplemented from SelectMgr_EntityOwner.

Standard_Boolean StdSelect_BRepOwner::HasHilightMode  )  const [inline]
 

Standard_Boolean StdSelect_BRepOwner::HasShape  )  const [inline]
 

virtual Standard_EXPORT void StdSelect_BRepOwner::Hilight const Handle(PrsMgr_PresentationManager)&  aPM,
const Standard_Integer  aMode = 0
[virtual]
 

Reimplemented from SelectMgr_EntityOwner.

virtual Standard_EXPORT void StdSelect_BRepOwner::Hilight  )  [virtual]
 

Reimplemented from SelectMgr_EntityOwner.

Standard_Integer StdSelect_BRepOwner::HilightMode  )  const [inline]
 

virtual Standard_EXPORT void StdSelect_BRepOwner::HilightWithColor const Handle(PrsMgr_PresentationManager3d)&  aPM,
const Quantity_NameOfColor  aCol,
const Standard_Integer  aMode = 0
[virtual]
 

Reimplemented from SelectMgr_EntityOwner.

virtual Standard_EXPORT Standard_Boolean StdSelect_BRepOwner::IsHilighted const Handle(PrsMgr_PresentationManager)&  aPM,
const Standard_Integer  aMode = 0
const [virtual]
 

Reimplemented from SelectMgr_EntityOwner.

void StdSelect_BRepOwner::ResetHilightMode  )  [inline]
 

virtual Standard_EXPORT void StdSelect_BRepOwner::ResetLocation  )  [virtual]
 

Reimplemented from SelectMgr_EntityOwner.

Standard_EXPORT void StdSelect_BRepOwner::Set const TopoDS_Shape &  aShape,
const Standard_Boolean  FromDecomposition = Standard_False
 

void StdSelect_BRepOwner::SetHilightMode const Standard_Integer  aMode  )  [inline]
 

virtual Standard_EXPORT void StdSelect_BRepOwner::SetLocation const TopLoc_Location &  aLoc  )  [virtual]
 

Reimplemented from SelectMgr_EntityOwner.

const TopoDS_Shape & StdSelect_BRepOwner::Shape  )  const [inline]
 

virtual Standard_EXPORT void StdSelect_BRepOwner::Unhilight const Handle(PrsMgr_PresentationManager)&  aPM,
const Standard_Integer  aMode = 0
[virtual]
 

Reimplemented from SelectMgr_EntityOwner.


Field Documentation

Standard_Integer StdSelect_BRepOwner::myCurMode [private]
 

Standard_Boolean StdSelect_BRepOwner::myFromDecomposition [protected]
 

Handle_StdSelect_Shape StdSelect_BRepOwner::myPrsSh [private]
 

TopoDS_Shape StdSelect_BRepOwner::myShape [protected]
 


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