Open CASCADE Technology  7.0.0
Public Types | Public Member Functions

IVtk_IShapePickerAlgo Class Referenceabstract

Interface for 3D shapes picking algorithm. More...

#include <IVtk_IShapePickerAlgo.hxx>

Inheritance diagram for IVtk_IShapePickerAlgo:
Inheritance graph
[legend]

Public Types

typedef Handle< IVtk_IShapePickerAlgoHandle
 
- Public Types inherited from IVtk_Interface
typedef Handle< IVtk_InterfaceHandle
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Public Member Functions

virtual ~IVtk_IShapePickerAlgo ()
 
virtual void SetView (const IVtk_IView::Handle &theView)=0
 
virtual int NbPicked ()=0
 
virtual IVtk_SelectionModeList GetSelectionModes (const IVtk_IShape::Handle &theShape) const =0
 Get activated selection modes for a shape. More...
 
virtual void SetSelectionMode (const IVtk_IShape::Handle &theShape, const IVtk_SelectionMode theMode, const bool theIsTurnOn=true)=0
 Activates/deactivates the given selection mode for the shape. If mode == SM_None, the shape becomes non-selectable and is removed from the internal selection data. More...
 
virtual void SetSelectionMode (const IVtk_ShapePtrList &theShapes, const IVtk_SelectionMode theMode, const bool theIsTurnOn=true)=0
 Activates/deactivates the given selection mode for the shape. If mode == SM_None, the shape becomes non-selectable and is removed from the internal selection data. More...
 
virtual bool Pick (const double theX, const double theY)=0
 
virtual bool Pick (const double theXMin, const double theYMin, const double theXMax, const double theYMax)=0
 
virtual bool Pick (double **, const int theNbPoints)=0
 
virtual const IVtk_ShapeIdListShapesPicked () const =0
 
virtual void SubShapesPicked (const IVtk_IdType theId, IVtk_ShapeIdList &theShapeList) const =0
 
- Public Member Functions inherited from IVtk_Interface
virtual ~IVtk_Interface ()
 
- 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

- 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

Interface for 3D shapes picking algorithm.

Member Typedef Documentation

Constructor & Destructor Documentation

virtual IVtk_IShapePickerAlgo::~IVtk_IShapePickerAlgo ( )
inlinevirtual

Member Function Documentation

virtual IVtk_SelectionModeList IVtk_IShapePickerAlgo::GetSelectionModes ( const IVtk_IShape::Handle theShape) const
pure virtual

Get activated selection modes for a shape.

Parameters
[in]theShapea shape with activated selection mode(s)
Returns
list of active selection modes

Implemented in IVtkOCC_ShapePickerAlgo.

virtual int IVtk_IShapePickerAlgo::NbPicked ( )
pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

virtual bool IVtk_IShapePickerAlgo::Pick ( const double  theX,
const double  theY 
)
pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

virtual bool IVtk_IShapePickerAlgo::Pick ( const double  theXMin,
const double  theYMin,
const double  theXMax,
const double  theYMax 
)
pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

virtual bool IVtk_IShapePickerAlgo::Pick ( double **  ,
const int  theNbPoints 
)
pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

virtual void IVtk_IShapePickerAlgo::SetSelectionMode ( const IVtk_IShape::Handle theShape,
const IVtk_SelectionMode  theMode,
const bool  theIsTurnOn = true 
)
pure virtual

Activates/deactivates the given selection mode for the shape. If mode == SM_None, the shape becomes non-selectable and is removed from the internal selection data.

Parameters
[in]theShapeShape for which the selection mode should be activated
[in]theModeSelection mode to be activated
[in]theIsTurnOnFlag to turn on/off the selection mode

Implemented in IVtkOCC_ShapePickerAlgo.

virtual void IVtk_IShapePickerAlgo::SetSelectionMode ( const IVtk_ShapePtrList theShapes,
const IVtk_SelectionMode  theMode,
const bool  theIsTurnOn = true 
)
pure virtual

Activates/deactivates the given selection mode for the shape. If mode == SM_None, the shape becomes non-selectable and is removed from the internal selection data.

Parameters
[in]theShapesList of shapes for which the selection mode should be activated
[in]theModeSelection mode to be activated
[in]theIsTurnOnFlag to turn on/off the selection mode

Implemented in IVtkOCC_ShapePickerAlgo.

virtual void IVtk_IShapePickerAlgo::SetView ( const IVtk_IView::Handle theView)
pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

virtual const IVtk_ShapeIdList& IVtk_IShapePickerAlgo::ShapesPicked ( ) const
pure virtual
Returns
the list of picked top-level shape IDs, in the order of increasing depth (the ID of the shape closest to the eye is the first in the list)

Implemented in IVtkOCC_ShapePickerAlgo.

virtual void IVtk_IShapePickerAlgo::SubShapesPicked ( const IVtk_IdType  theId,
IVtk_ShapeIdList theShapeList 
) const
pure virtual
Parameters
[in]theIdTop-level shape ID
[out]theShapeListthe list of picked sub-shape IDs for the given top-level shape ID, in the order of increasing depth (the ID of the sub-shape closest to the eye is the first in the list)

Implemented in IVtkOCC_ShapePickerAlgo.


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