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

#include <IVtk_IShapePickerAlgo.hxx>

Inheritance diagram for IVtk_IShapePickerAlgo:

[legend]

Public Types
typedef Handle< IVtk_IShapePickerAlgo >	Handle

Public Types inherited from IVtk_Interface
typedef Handle< IVtk_Interface >	Handle

Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

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.

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.

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.

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_ShapeIdList &	ShapesPicked () 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.

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

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

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

Standard_Transient *	This () 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.

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

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Interface for 3D shapes picking algorithm.

Member Typedef Documentation

◆ Handle

typedef Handle< IVtk_IShapePickerAlgo > IVtk_IShapePickerAlgo::Handle

Constructor & Destructor Documentation

◆ ~IVtk_IShapePickerAlgo()

virtual IVtk_IShapePickerAlgo::~IVtk_IShapePickerAlgo ( )

inlinevirtual

Member Function Documentation

◆ GetSelectionModes()

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

pure virtual

Get activated selection modes for a shape.

Parameters

[in] theShape a shape with activated selection mode(s)

Returns: list of active selection modes

Implemented in IVtkOCC_ShapePickerAlgo.

◆ NbPicked()

virtual int IVtk_IShapePickerAlgo::NbPicked ( )

pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

◆ Pick() [1/3]

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

pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

◆ Pick() [2/3]

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

pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

◆ Pick() [3/3]

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

pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

◆ SetSelectionMode() [1/2]

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]	theShape	Shape for which the selection mode should be activated
[in]	theMode	Selection mode to be activated
[in]	theIsTurnOn	Flag to turn on/off the selection mode

Implemented in IVtkOCC_ShapePickerAlgo.

◆ SetSelectionMode() [2/2]

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]	theShapes	List of shapes for which the selection mode should be activated
[in]	theMode	Selection mode to be activated
[in]	theIsTurnOn	Flag to turn on/off the selection mode

Implemented in IVtkOCC_ShapePickerAlgo.

◆ SetView()

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

pure virtual

Implemented in IVtkOCC_ShapePickerAlgo.

◆ ShapesPicked()

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.

◆ SubShapesPicked()

virtual void IVtk_IShapePickerAlgo::SubShapesPicked	(	const IVtk_IdType	theId,
		IVtk_ShapeIdList &	theShapeList
	)		const

pure virtual

Parameters

[in]	theId	Top-level shape ID
[out]	theShapeList	the 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:

IVtk_IShapePickerAlgo.hxx

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Handle

Constructor & Destructor Documentation

◆ ~IVtk_IShapePickerAlgo()

Member Function Documentation

◆ GetSelectionModes()

◆ NbPicked()

◆ Pick() [1/3]

◆ Pick() [2/3]

◆ Pick() [3/3]

◆ SetSelectionMode() [1/2]

◆ SetSelectionMode() [2/2]

◆ SetView()

◆ ShapesPicked()

◆ SubShapesPicked()