#include <MeshVS_SensitivePolyhedron.hxx>

Inheritance diagram for MeshVS_SensitivePolyhedron:

[legend]

Public Member Functions
	MeshVS_SensitivePolyhedron (const Handle< SelectBasics_EntityOwner > &Owner, const TColgp_Array1OfPnt &Nodes, const Handle< MeshVS_HArray1OfSequenceOfInteger > &Topo)

virtual void	Project (const Handle< Select3D_Projector > &aProjector)
	In classes inheriting this framework, you must <br> redefine this function in order to get a sensitive 2D rectangle from a 3D entity. This rectangle is the sensitive zone which makes the 3D entity selectable. More...

virtual Handle_Select3D_SensitiveEntity	GetConnected (const TopLoc_Location &aLocation)
	Originally this method intended to return sensitive <br> entity with new location aLocation, but currently sensitive entities do not hold a location, instead HasLocation() and Location() methods call corresponding entity owner's methods. Thus all entities returned by GetConnected() share the same location propagated from corresponding selectable object. You must redefine this function for any type of sensitive entity which can accept another connected sensitive entity.//can be connected to another sensitive entity. More...

virtual Standard_Boolean	Matches (const SelectBasics_PickArgs &thePickArgs, Standard_Real &theMatchDMin, Standard_Real &theMatchDepth)
	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)
	Matches the box defined by the coordinates Xmin, <br> Ymin, Xmax, Ymax with the entity found at that point within the tolerance aTol. Xmin, YMin define the minimum point in the lower left hand corner of the box, and XMax, YMax define the maximum point in the upper right hand corner of the box. You must redefine this function for every inheriting entity. You will have to call this framework inside the redefined function. More...

virtual Standard_Boolean	Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
	prevents from hiding virtual methods... More...

virtual Standard_Real	ComputeDepth (const gp_Lin &EyeLine) const

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

Public Member Functions inherited from Select3D_SensitiveEntity
Standard_Boolean	NeedsConversion () const
	Returns true if this framework needs conversion. More...

Standard_Boolean	Is3D () const
	Returns true if this framework provides 3D information. More...

virtual Standard_Integer	MaxBoxes () const
	Returns the max number of sensitive areas returned by this class is 1 by default. Else on must redefine this method. More...

virtual Standard_Boolean	HasLocation () const
	Returns true if this framework has a location defined. More...

virtual const TopLoc_Location &	Location () const

virtual void	ResetLocation ()
	sets the location to Identity More...

virtual void	SetLocation (const TopLoc_Location &aLoc)

virtual void	Dump (Standard_OStream &S, const Standard_Boolean FullDump=Standard_True) const
	2 options : <FullDump> = False -> general information <FullDump> = True -> whole informtion 3D +2d ... More...

void	UpdateLocation (const TopLoc_Location &aLoc)

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

const Handle_SelectBasics_EntityOwner &	OwnerId () const

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
void	GetBox2d (Bnd_Box2d &aBox) const

Standard_Real	FindIntersection (const TColStd_SequenceOfInteger &NodesIndices, const gp_Lin &EyeLine) const

Protected Member Functions inherited from Select3D_SensitiveEntity
	Select3D_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &OwnerId)

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

Additional Inherited Members
Static Public Member Functions inherited from Select3D_SensitiveEntity
static void	DumpBox (Standard_OStream &S, const Bnd_Box2d &abox)

Protected Attributes inherited from SelectBasics_SensitiveEntity
Handle_SelectBasics_EntityOwner	myOwnerId

Constructor & Destructor Documentation

MeshVS_SensitivePolyhedron::MeshVS_SensitivePolyhedron	(	const Handle< SelectBasics_EntityOwner > &	Owner,
		const TColgp_Array1OfPnt &	Nodes,
		const Handle< MeshVS_HArray1OfSequenceOfInteger > &	Topo
	)

Member Function Documentation

virtual void MeshVS_SensitivePolyhedron::Areas ( SelectBasics_ListOfBox2d & aresult )

virtual

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

Implements SelectBasics_SensitiveEntity.

virtual Standard_Real MeshVS_SensitivePolyhedron::ComputeDepth ( const gp_Lin & EyeLine ) const

virtual

Standard_Real MeshVS_SensitivePolyhedron::FindIntersection	(	const TColStd_SequenceOfInteger &	NodesIndices,
		const gp_Lin &	EyeLine
	)		const

protected

void MeshVS_SensitivePolyhedron::GetBox2d ( Bnd_Box2d & aBox ) const

protected

virtual Handle_Select3D_SensitiveEntity MeshVS_SensitivePolyhedron::GetConnected ( const TopLoc_Location & aLocation )

virtual

 Originally this method intended to return sensitive <br>

entity with new location aLocation, but currently sensitive
entities do not hold a location, instead HasLocation() and
Location() methods call corresponding entity owner's methods.
Thus all entities returned by GetConnected() share the same
location propagated from corresponding selectable object.
You must redefine this function for any type of
sensitive entity which can accept another connected
sensitive entity.//can be connected to another sensitive entity.

Reimplemented from Select3D_SensitiveEntity.

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

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.

Implements SelectBasics_SensitiveEntity.

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

virtual

 Matches the box defined by the coordinates Xmin, <br>

Ymin, Xmax, Ymax with the entity found at that point
within the tolerance aTol.
Xmin, YMin define the minimum point in the lower left
hand corner of the box, and XMax, YMax define the
maximum point in the upper right hand corner of the box.
You must redefine this function for every inheriting entity.
You will have to call this framework inside the redefined function.

Reimplemented from Select3D_SensitiveEntity.

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

virtual

prevents from hiding virtual methods...

Reimplemented from Select3D_SensitiveEntity.

virtual void MeshVS_SensitivePolyhedron::Project ( const Handle< Select3D_Projector > & aProjector )

virtual

 In classes inheriting this framework, you must <br>

redefine this function in order to get a sensitive 2D
rectangle from a 3D entity. This rectangle is the
sensitive zone which makes the 3D entity selectable.

Implements Select3D_SensitiveEntity.

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

MeshVS_SensitivePolyhedron.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation