Open CASCADE Technology 6.6.0
Public Member Functions
SelectMgr_EntityOwner Class Reference

A framework to define classes of owners of sensitive primitives.
The owner is the link between application and
selection data structures.
For the application to make its own objects selectable,
it must define owner classes inheriting this framework.

#include <SelectMgr_EntityOwner.hxx>

Inheritance diagram for SelectMgr_EntityOwner:
Inheritance graph
[legend]

Public Member Functions

 SelectMgr_EntityOwner (const Standard_Integer aPriority=0)
 Initializes the selection priority aPriority.

 SelectMgr_EntityOwner (const Handle< SelectMgr_SelectableObject > &aSO, const Standard_Integer aPriority=0)
 Constructs a framework with the selectable object
anSO being attributed the selection priority aPriority.

Standard_Boolean HasSelectable () const
 Returns true if there is a selectable object to serve as an owner.

Handle_SelectMgr_SelectableObject Selectable () const
 Returns a selectable object detected in the working context.

void Set (const Handle< SelectMgr_SelectableObject > &aSO)
 Sets the selectable object anSO to be used by the
second constructor above.

virtual void Hilight ()
 Provides a framework to highlight any selectable
object found subsequently which can serve as an
owner of a sensitive primitive.

virtual Standard_Boolean IsHilighted (const Handle< PrsMgr_PresentationManager > &aPM, const Standard_Integer aMode=0) const
 Returns true if the presentation manager aPM
highlights selections corresponding to the selection mode aMode.

virtual void Hilight (const Handle< PrsMgr_PresentationManager > &aPM, const Standard_Integer aMode=0)
 Highlights the owner of a detected selectable object in
the presentation manager aPM. This object could be
the owner of a sensitive primitive.
The display mode for the highlight is aMode; this has
the default value of 0, that is, wireframe mode.

virtual void HilightWithColor (const Handle< PrsMgr_PresentationManager3d > &aPM, const Quantity_NameOfColor aColor, const Standard_Integer aMode=0)
virtual void Unhilight (const Handle< PrsMgr_PresentationManager > &aPM, const Standard_Integer aMode=0)
 Removes highlighting from the owner of a detected
selectable object in the presentation manager aPM.
This object could be the owner of a sensitive primitive.
The display mode for the highlight is aMode; this has
the default value of 0, that is, wireframe mode.

virtual void Clear (const Handle< PrsMgr_PresentationManager > &aPM, const Standard_Integer aMode=0)
 Clears the owners matching the value of the selection
mode aMode from the presentation manager object aPM.

virtual Standard_Boolean HasLocation () const
virtual void SetLocation (const TopLoc_Location &aLoc)
virtual void ResetLocation ()
virtual const TopLoc_LocationLocation () const
void State (const Standard_Integer aStatus)
Standard_Integer State () const
virtual Standard_Boolean IsAutoHilight () const
 if owner is not auto hilighted, for group contains many such owners
will be called one method HilightSelected of SelectableObject

virtual Standard_Boolean IsForcedHilight () const
 if this method returns TRUE the owner will allways call method
Hilight for SelectableObject when the owner is detected. By default
it always return FALSE.

virtual void SetZLayer (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Standard_Integer theLayerId)
 Set Z layer ID and update all presentations.


Constructor & Destructor Documentation

SelectMgr_EntityOwner::SelectMgr_EntityOwner ( const Standard_Integer  aPriority = 0)
SelectMgr_EntityOwner::SelectMgr_EntityOwner ( const Handle< SelectMgr_SelectableObject > &  aSO,
const Standard_Integer  aPriority = 0 
)

Member Function Documentation

virtual void SelectMgr_EntityOwner::Clear ( const Handle< PrsMgr_PresentationManager > &  aPM,
const Standard_Integer  aMode = 0 
) [virtual]
virtual Standard_Boolean SelectMgr_EntityOwner::HasLocation ( ) const [virtual]
Standard_Boolean SelectMgr_EntityOwner::HasSelectable ( ) const
virtual void SelectMgr_EntityOwner::Hilight ( ) [virtual]
virtual void SelectMgr_EntityOwner::Hilight ( const Handle< PrsMgr_PresentationManager > &  aPM,
const Standard_Integer  aMode = 0 
) [virtual]
virtual void SelectMgr_EntityOwner::HilightWithColor ( const Handle< PrsMgr_PresentationManager3d > &  aPM,
const Quantity_NameOfColor  aColor,
const Standard_Integer  aMode = 0 
) [virtual]
virtual Standard_Boolean SelectMgr_EntityOwner::IsAutoHilight ( ) const [virtual]
virtual Standard_Boolean SelectMgr_EntityOwner::IsForcedHilight ( ) const [virtual]

Reimplemented in MeshVS_MeshOwner.

virtual Standard_Boolean SelectMgr_EntityOwner::IsHilighted ( const Handle< PrsMgr_PresentationManager > &  aPM,
const Standard_Integer  aMode = 0 
) const [virtual]
virtual const TopLoc_Location& SelectMgr_EntityOwner::Location ( ) const [virtual]
virtual void SelectMgr_EntityOwner::ResetLocation ( ) [virtual]

Implements SelectBasics_EntityOwner.

Reimplemented in StdSelect_BRepOwner.

Handle_SelectMgr_SelectableObject SelectMgr_EntityOwner::Selectable ( ) const
void SelectMgr_EntityOwner::Set ( const Handle< SelectMgr_SelectableObject > &  aSO)
virtual void SelectMgr_EntityOwner::SetLocation ( const TopLoc_Location aLoc) [virtual]

Implements SelectBasics_EntityOwner.

Reimplemented in StdSelect_BRepOwner.

virtual void SelectMgr_EntityOwner::SetZLayer ( const Handle< PrsMgr_PresentationManager > &  thePrsMgr,
const Standard_Integer  theLayerId 
) [virtual]

Reimplemented in StdSelect_BRepOwner.

Standard_Integer SelectMgr_EntityOwner::State ( ) const
void SelectMgr_EntityOwner::State ( const Standard_Integer  aStatus)
virtual void SelectMgr_EntityOwner::Unhilight ( const Handle< PrsMgr_PresentationManager > &  aPM,
const Standard_Integer  aMode = 0 
) [virtual]

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines