VTK picker for OCC shapes with OCC selection algorithm. More...

#include <IVtkTools_ShapePicker.hxx>

Inheritance diagram for IVtkTools_ShapePicker:

Public Member Functions
	vtkTypeMacro (IVtkTools_ShapePicker, vtkAbstractPropPicker) static IVtkTools_ShapePicker *New()

int	pick (double thePos, vtkRenderer theRenderer, const int theNbPoints=-1)
	Pick entities in the given point or area.

int	Pick (double theX, double theY, double theZ, vtkRenderer *theRenderer=nullptr) override
	Pick entities in the given point.

int	Pick (double theX0, double theY0, double theX1, double theY1, vtkRenderer *theRenderer=nullptr)
	Pick entities in the given rectangle area.

int	Pick (double poly[][3], const int theNbPoints, vtkRenderer *theRenderer=nullptr)
	Pick entities in the given polygonal area.

void	SetPixelTolerance (const int theTolerance)
	Sets the pixel-space selection tolerance applied on every subsequent Pick. Forwards to SelectMgr_ViewerSelector::SetPixelTolerance via the underlying picker algorithm.

int	PixelTolerance () const
	Returns the current pixel-space selection tolerance.

void	SetRenderer (vtkRenderer *theRenderer)
	Sets the renderer to be used by OCCT selection algorithm.

void	SetAreaSelection (bool theIsOn)
	Sets area selection on/off.

NCollection_List< IVtk_SelectionMode >	GetSelectionModes (const IVtk_IShape::Handle &theShape) const
	Get activated selection modes for a shape.

NCollection_List< IVtk_SelectionMode >	GetSelectionModes (vtkActor *theShapeActor) const
	Get activated selection modes for a shape actor.

void	SetSelectionMode (const IVtk_IShape::Handle &theShape, const IVtk_SelectionMode theMode, const bool theIsTurnOn=true) const
	Turn on/off a selection mode for a shape actor.

void	SetSelectionMode (vtkActor *theShapeActor, const IVtk_SelectionMode theMode, const bool theIsTurnOn=true) const
	Turn on/off a selection mode for a shape actor.

void	SetSelectionMode (const IVtk_SelectionMode theMode, const bool theIsTurnOn=true) const
	Sets the current selection mode for all visible shape objects.

NCollection_List< IVtk_IdType >	GetPickedShapesIds (bool theIsAll=false) const
	Access to the list of top-level shapes picked. If all argument is true, the picker returns the list of all OccShape objects found by the picking algorithm. e.g. all shapes under the mouse cursor. Otherwise, ID of the shape closest to the eye is returned.

NCollection_List< IVtk_IdType >	GetPickedSubShapesIds (const IVtk_IdType theId, bool theIsAll=false) const
	Access to the list of sub-shapes ids picked.

vtkSmartPointer< vtkActorCollection >	GetPickedActors (bool theIsAll=false) const
	Access to the list of actors picked.

void	RemoveSelectableObject (const IVtk_IShape::Handle &theShape)
	Remove selectable object from the picker (from internal maps).

void	RemoveSelectableActor (vtkActor *theShapeActor)
	Remove selectable object from the picker (from internal maps).

Protected Member Functions
	IVtkTools_ShapePicker ()
	Constructs the picker with empty renderer and ready for point selection.

	~IVtkTools_ShapePicker () override
	Destructor.

Static Protected Member Functions
static bool	convertDisplayToWorld (vtkRenderer *theRenderer, double theDisplayCoord[3], double theWorldCoord[3])
	Convert display coordinates to world coordinates.

Detailed Description

VTK picker for OCC shapes with OCC selection algorithm.

Constructor & Destructor Documentation

◆ IVtkTools_ShapePicker()

IVtkTools_ShapePicker::IVtkTools_ShapePicker ( )

protected

Constructs the picker with empty renderer and ready for point selection.

◆ ~IVtkTools_ShapePicker()

IVtkTools_ShapePicker::~IVtkTools_ShapePicker ( )

overrideprotected

Destructor.

Member Function Documentation

◆ convertDisplayToWorld()

static bool IVtkTools_ShapePicker::convertDisplayToWorld	(	vtkRenderer *	theRenderer,
		double	theDisplayCoord[3],
		double	theWorldCoord[3] )

staticprotected

Convert display coordinates to world coordinates.

◆ GetPickedActors()

vtkSmartPointer< vtkActorCollection > IVtkTools_ShapePicker::GetPickedActors ( bool theIsAll = false ) const

Access to the list of actors picked.

Parameters

[in] theIsAll Get all selected actors or just the only top one is returned, has no effect during area selection.

Returns: List of actors IDs

◆ GetPickedShapesIds()

NCollection_List< IVtk_IdType > IVtkTools_ShapePicker::GetPickedShapesIds ( bool theIsAll = false ) const

Access to the list of top-level shapes picked. If all argument is true, the picker returns the list of all OccShape objects found by the picking algorithm. e.g. all shapes under the mouse cursor. Otherwise, ID of the shape closest to the eye is returned.

Parameters

[in] theIsAll Get all selected shapes or just the only top one is returned, has no effect during area selection.

Returns: List of top-level shape IDs

◆ GetPickedSubShapesIds()

NCollection_List< IVtk_IdType > IVtkTools_ShapePicker::GetPickedSubShapesIds	(	const IVtk_IdType	theId,
		bool	theIsAll = false ) const

Access to the list of sub-shapes ids picked.

Parameters

[in]	theId	top-level shape ID
[in]	theIsAll	Get all selected sub-shapes or just the only top one is returned, has no effect during area selection.

Returns: List of sub-shapes IDs

◆ GetSelectionModes() [1/2]

NCollection_List< IVtk_SelectionMode > IVtkTools_ShapePicker::GetSelectionModes ( const IVtk_IShape::Handle & theShape ) const

Get activated selection modes for a shape.

Parameters

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

Returns: list of active selection modes

◆ GetSelectionModes() [2/2]

NCollection_List< IVtk_SelectionMode > IVtkTools_ShapePicker::GetSelectionModes ( vtkActor * theShapeActor ) const

Get activated selection modes for a shape actor.

Parameters

[in] theShapeActor an actor with activated selection mode(s)

Returns: list of active selection modes

◆ pick()

int IVtkTools_ShapePicker::pick	(	double *	thePos,
		vtkRenderer *	theRenderer,
		const int	theNbPoints = -1 )

Pick entities in the given point or area.

Returns: Number of detected entities.

◆ Pick() [1/3]

int IVtkTools_ShapePicker::Pick	(	double	poly[][3],
		const int	theNbPoints,
		vtkRenderer *	theRenderer = nullptr )

Pick entities in the given polygonal area.

Returns: Number of detected entities.

◆ Pick() [2/3]

int IVtkTools_ShapePicker::Pick	(	double	theX,
		double	theY,
		double	theZ,
		vtkRenderer *	theRenderer = nullptr )

override

Pick entities in the given point.

Returns: Number of detected entities.

◆ Pick() [3/3]

int IVtkTools_ShapePicker::Pick	(	double	theX0,
		double	theY0,
		double	theX1,
		double	theY1,
		vtkRenderer *	theRenderer = nullptr )

Pick entities in the given rectangle area.

Returns: Number of detected entities.

◆ PixelTolerance()

int IVtkTools_ShapePicker::PixelTolerance ( ) const

Returns the current pixel-space selection tolerance.

◆ RemoveSelectableActor()

void IVtkTools_ShapePicker::RemoveSelectableActor ( vtkActor * theShapeActor )

Remove selectable object from the picker (from internal maps).

Parameters

[in] theShapeActor the shape presentation actor to be removed from the picker

◆ RemoveSelectableObject()

void IVtkTools_ShapePicker::RemoveSelectableObject ( const IVtk_IShape::Handle & theShape )

Remove selectable object from the picker (from internal maps).

Parameters

[in] theShape the selectable shape

◆ SetAreaSelection()

void IVtkTools_ShapePicker::SetAreaSelection ( bool theIsOn )

Sets area selection on/off.

Parameters

[in] theIsOn true if area selection is turned on, false otherwise.

◆ SetPixelTolerance()

void IVtkTools_ShapePicker::SetPixelTolerance ( const int theTolerance )

Sets the pixel-space selection tolerance applied on every subsequent Pick. Forwards to SelectMgr_ViewerSelector::SetPixelTolerance via the underlying picker algorithm.

◆ SetRenderer()

void IVtkTools_ShapePicker::SetRenderer ( vtkRenderer * theRenderer )

Sets the renderer to be used by OCCT selection algorithm.

◆ SetSelectionMode() [1/3]

void IVtkTools_ShapePicker::SetSelectionMode	(	const IVtk_IShape::Handle &	theShape,
		const IVtk_SelectionMode	theMode,
		const bool	theIsTurnOn = true ) const

Turn on/off a selection mode for a shape actor.

Parameters

[in]	theShape	a shape to set a selection mode for
[in]	theMode	selection mode to be activated
[in]	theIsTurnOn	Flag to turn on/off the selection mode

◆ SetSelectionMode() [2/3]

void IVtkTools_ShapePicker::SetSelectionMode	(	const IVtk_SelectionMode	theMode,
		const bool	theIsTurnOn = true ) const

Sets the current selection mode for all visible shape objects.

Parameters

[in]	theMode	selection mode to be activated
[in]	theIsTurnOn	Flag to turn on/off the selection mode

◆ SetSelectionMode() [3/3]

void IVtkTools_ShapePicker::SetSelectionMode	(	vtkActor *	theShapeActor,
		const IVtk_SelectionMode	theMode,
		const bool	theIsTurnOn = true ) const

Turn on/off a selection mode for a shape actor.

Parameters

[in]	theShapeActor	shape presentation actor to set a selection mode for
[in]	theMode	selection mode to be activated
[in]	theIsTurnOn	Flag to turn on/off the selection mode

◆ vtkTypeMacro()

IVtkTools_ShapePicker::vtkTypeMacro	(	IVtkTools_ShapePicker	,
		vtkAbstractPropPicker	)

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

IVtkTools_ShapePicker.hxx

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IVtkTools_ShapePicker()

◆ ~IVtkTools_ShapePicker()

Member Function Documentation

◆ convertDisplayToWorld()

◆ GetPickedActors()

◆ GetPickedShapesIds()

◆ GetPickedSubShapesIds()

◆ GetSelectionModes() [1/2]

◆ GetSelectionModes() [2/2]

◆ pick()

◆ Pick() [1/3]

◆ Pick() [2/3]

◆ Pick() [3/3]

◆ PixelTolerance()

◆ RemoveSelectableActor()

◆ RemoveSelectableObject()

◆ SetAreaSelection()

◆ SetPixelTolerance()

◆ SetRenderer()

◆ SetSelectionMode() [1/3]

◆ SetSelectionMode() [2/3]

◆ SetSelectionMode() [3/3]

◆ vtkTypeMacro()