root class ; the inheriting classes will be able to give
sensitive Areas for the dynamic selection algorithms
More...

#include <SelectBasics_SensitiveEntity.hxx>

Inheritance diagram for SelectBasics_SensitiveEntity:

[legend]

Public Member Functions
virtual void	Set (const Handle< SelectBasics_EntityOwner > &TheOwnerId)

const Handle_SelectBasics_EntityOwner &	OwnerId () const

virtual void	Areas (SelectBasics_ListOfBox2d &aresult)=0
	to be implemented specifically by each type of <br> sensitive primitive . <br> More...

virtual Standard_Boolean	Matches (const SelectBasics_PickArgs &thePickArgs, Standard_Real &theMatchDMin, Standard_Real &theMatchDepth)=0
	Checks whether the sensitive entity matches the picking detection <br> area (close to the picking line). This method takes into account depth limits produced by abstract view: far/near planes, clippings. Please port existing implementations of your picking detection, which were done at Matches (X, Y, Tol, DMin) method to this one, introducing the depth checks. Please note that the previous method is suppressed and the virtual implementations are not used by OCC selection framework. The porting procedure for simple sensitives (or if you are not interested in implementing full scale depth checks) can be simplified to writing the following code snippet: More...

virtual Standard_Boolean	Matches (const Standard_Real XMin, const Standard_Real YMin, const Standard_Real XMax, const Standard_Real YMax, const Standard_Real aTol)=0
	returns True if the box (Xmin,YMin)---—(Xmax,Ymax) contains the SensitiveEntity. Necessary for selection using elastic boxes,or segments. More...

virtual Standard_Boolean	Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)=0
	returns True if the polyline xi,yi contains the SensitiveEntity. Necessary for selection using polyline selection More...

virtual Standard_Boolean	NeedsConversion () const =0

virtual Standard_Boolean	Is3D () const =0
	returns True if able to give 3D information (Depth,...). See Select3D More...

virtual Standard_Integer	MaxBoxes () const =0
	returns the max number of boxes the entity is able to give at a time More...

void	SetSensitivityFactor (const Standard_ShortReal aFactor)

Standard_ShortReal	SensitivityFactor () const
	allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities. More...

Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const
	Memory deallocator for transient classes. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

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

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

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const 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 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...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

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

Protected Member Functions
	SelectBasics_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &OwnerId, const Standard_ShortReal aSensitivityFactor=1)

Protected Attributes
Handle_SelectBasics_EntityOwner	myOwnerId

Detailed Description

root class ; the inheriting classes will be able to give
sensitive Areas for the dynamic selection algorithms

Constructor & Destructor Documentation

SelectBasics_SensitiveEntity::SelectBasics_SensitiveEntity	(	const Handle< SelectBasics_EntityOwner > &	OwnerId,
		const Standard_ShortReal	aSensitivityFactor = `1`
	)

protected

Member Function Documentation

virtual void SelectBasics_SensitiveEntity::Areas ( SelectBasics_ListOfBox2d & aresult )

pure virtual

 to be implemented specifically by each type of <br>
     sensitive  primitive . <br>

Implemented in Select3D_SensitiveTriangulation, Select3D_SensitiveSegment, Select3D_SensitiveGroup, MeshVS_SensitivePolyhedron, Select3D_SensitiveBox, MeshVS_SensitiveMesh, Select3D_SensitiveWire, Select3D_SensitivePoint, Select3D_SensitivePoly, and MeshVS_DummySensitiveEntity.

virtual Standard_Boolean SelectBasics_SensitiveEntity::Is3D ( ) const

pure virtual

returns True if able to give 3D information
(Depth,...). See Select3D

Implemented in MeshVS_DummySensitiveEntity, and Select3D_SensitiveEntity.

virtual Standard_Boolean SelectBasics_SensitiveEntity::Matches	(	const SelectBasics_PickArgs &	thePickArgs,
		Standard_Real &	theMatchDMin,
		Standard_Real &	theMatchDepth
	)

pure virtual

 Checks whether the sensitive entity matches the picking detection <br>

area (close to the picking line). This method takes into account depth
limits produced by abstract view: far/near planes, clippings.
Please port existing implementations of your picking detection, which
were done at Matches (X, Y, Tol, DMin) method to this one, introducing
the depth checks. Please note that the previous method is suppressed
and the virtual implementations are not used by OCC selection framework.
The porting procedure for simple sensitives (or if you are not interested
in implementing full scale depth checks) can be simplified to writing the
following code snippet:

 <br>
{ // example code for porting descendants of Select3D_SensitiveEntity <br>
<br>
  // invoke implementation of obsolete matches method (if implemented)... <br>
  if (!Matches (thePickArgs.X(), thePickArgs.Y(), thePickArgs.Tolerance(), theMatchDMin)) <br>
    return Standard_False; <br>
<br>
  // invoke your implementation of computing depth (if implemented)... <br>
  Standard_Real aDetectDepth = ComputeDepth (thePickArgs.PickLine()); <br>
<br>
  return !thePickArgs.IsClipped(aDetectDepth); <br>
} <br>

Parameters

thePickArgs	[in] the picking arguments.
theMatchDMin	[out] the minimum distance on xy plane from point of picking to center of gravity of the detected sub-part of sensitive entity or the whole sensitive (e.g. used for resolving selection of coinciding circles, selection will be set to the one whose center is closest to the picking point).
theMatchDepth	[out] the minimum detected depth: depth of the closest detected sub-part of sensitive entity (or the whole sensitive).

Returns: True if the sensitive matches the detection area.
This method is an entry point for picking detection framework.
The method is triggered when it is required to compose list of
detected sensitive entities. The sensitives are filtered out from
detection result if returned value is False. The passed entities are
then can be sorted by "theDetectDist", "theDetectDepth" parameters.

Implemented in Select3D_SensitiveGroup, Select3D_SensitiveTriangulation, Select3D_SensitiveSegment, Select3D_SensitiveCircle, Select3D_SensitiveWire, Select3D_SensitiveBox, Select3D_SensitiveCurve, Select3D_SensitivePoint, MeshVS_SensitivePolyhedron, Select3D_SensitiveFace, Select3D_SensitiveTriangle, MeshVS_SensitiveMesh, and MeshVS_DummySensitiveEntity.

virtual Standard_Boolean SelectBasics_SensitiveEntity::Matches	(	const Standard_Real	XMin,
		const Standard_Real	YMin,
		const Standard_Real	XMax,
		const Standard_Real	YMax,
		const Standard_Real	aTol
	)

pure virtual

returns True if the box (Xmin,YMin)---—(Xmax,Ymax)
contains the SensitiveEntity.
Necessary for selection using elastic boxes,or segments.

Implemented in Select3D_SensitiveGroup, Select3D_SensitiveTriangulation, Select3D_SensitiveSegment, Select3D_SensitiveCircle, Select3D_SensitiveWire, Select3D_SensitiveBox, Select3D_SensitiveEntity, Select3D_SensitiveCurve, Select3D_SensitivePoint, MeshVS_SensitivePolyhedron, Select3D_SensitiveFace, Select3D_SensitiveTriangle, MeshVS_SensitiveMesh, MeshVS_SensitiveFace, MeshVS_SensitiveSegment, and MeshVS_DummySensitiveEntity.

virtual Standard_Boolean SelectBasics_SensitiveEntity::Matches	(	const TColgp_Array1OfPnt2d &	Polyline,
		const Bnd_Box2d &	aBox,
		const Standard_Real	aTol
	)

pure virtual

returns True if the polyline xi,yi
contains the SensitiveEntity.
Necessary for selection using polyline selection

Implemented in Select3D_SensitiveGroup, Select3D_SensitiveTriangulation, Select3D_SensitiveSegment, Select3D_SensitiveCircle, Select3D_SensitiveWire, Select3D_SensitiveBox, Select3D_SensitiveEntity, Select3D_SensitiveCurve, Select3D_SensitivePoint, MeshVS_SensitivePolyhedron, Select3D_SensitiveFace, Select3D_SensitiveTriangle, MeshVS_SensitiveMesh, MeshVS_SensitiveFace, MeshVS_SensitiveSegment, and MeshVS_DummySensitiveEntity.

virtual Standard_Integer SelectBasics_SensitiveEntity::MaxBoxes ( ) const

pure virtual

returns the max number of boxes the entity is able to give
at a time

Implemented in Select3D_SensitiveSegment, Select3D_SensitiveGroup, Select3D_SensitiveWire, Select3D_SensitiveEntity, and MeshVS_DummySensitiveEntity.

virtual Standard_Boolean SelectBasics_SensitiveEntity::NeedsConversion ( ) const

pure virtual

Implemented in MeshVS_DummySensitiveEntity, and Select3D_SensitiveEntity.

const Handle_SelectBasics_EntityOwner& SelectBasics_SensitiveEntity::OwnerId ( ) const

Standard_ShortReal SelectBasics_SensitiveEntity::SensitivityFactor ( ) const

allows a better sensitivity for
a specific entity in selection algorithms
useful for small sized entities.

virtual void SelectBasics_SensitiveEntity::Set ( const Handle< SelectBasics_EntityOwner > & TheOwnerId )

virtual

Reimplemented in Select3D_SensitiveGroup, and Select3D_SensitiveWire.

void SelectBasics_SensitiveEntity::SetSensitivityFactor ( const Standard_ShortReal aFactor )

Field Documentation

Handle_SelectBasics_EntityOwner SelectBasics_SensitiveEntity::myOwnerId

protected

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

SelectBasics_SensitiveEntity.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation