OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
Select3D


Select3D_SensitiveEntity Class Reference

Abstract framework to define 3D sensitive entities.
As the selection process uses the principle of a
projection of 3D shapes onto a 2D view where
nearness to a rectangle determines whether a shape
is picked or not, all 3D shapes need to be converted
into 2D ones in order to be selected.
.

#include <Select3D_SensitiveEntity.hxx>

Inheritance diagram for Select3D_SensitiveEntity:

Inheritance graph
[legend]

Public Member Functions

Standard_Boolean NeedsConversion () const
 Returns true if this framework needs conversion.
.
Standard_EXPORT Standard_Boolean Is3D () const
 Returns true if this framework provides 3D information.
.
virtual Standard_EXPORT void Project (const Select3D_Projector &aProjector)
 Returns the projector aProjector.
In classes inheriting this framework, you must
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.
.
virtual Standard_EXPORT 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.
.
virtual Standard_EXPORT Handle_Select3D_SensitiveEntity GetConnected (const TopLoc_Location &aLocation)
 Returns the sensitive entity found at the location aLocation.
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.
.
virtual Standard_EXPORT Standard_Boolean Matches (const Standard_Real X, const Standard_Real Y, const Standard_Real aTol, Standard_Real &DMin)
 Matches the coordinates X, Y with the entity found at
that point within the tolerance aTol and the minimum depth DMin.
You must redefine this function for every inheriting entity.
You will have to call this framework inside the redefined function.
.
virtual Standard_EXPORT 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,
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.
.
virtual Standard_EXPORT Standard_Boolean Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
 prevents from hiding virtual methods...

Standard_EXPORT gp_Lin GetEyeLine (const Standard_Real X, const Standard_Real Y) const
 Returns the eye line for the point defined by the coordinates X,Y.
.
virtual Standard_EXPORT Standard_Real ComputeDepth (const gp_Lin &EyeLine) const =0
 Returns the depth of this object on the line EyeLine.
EyeLine goes through the eye towards a point
defined by the coordinates X,Y in the function GetEyeLine.
//! gives an abcissa on <alin> .
<alin> represents the line going through
the eye towards an X,Y point on the screen. This Method
must return a mean Depth on this line.
.
virtual Standard_EXPORT Standard_Real Depth () const
 Sort Selected entities according to depth...
.
virtual Standard_EXPORT Standard_Boolean HasLocation () const
 Returns true if this framework has a location defined.
.
virtual Standard_EXPORT const
TopLoc_Location & 
Location () const
virtual Standard_EXPORT void ResetLocation ()
 sets the location to Identity

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

Standard_EXPORT void UpdateLocation (const TopLoc_Location &aLoc)
virtual Standard_EXPORT void SetLastPrj (const Select3D_Projector &aPrj)
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Static Public Member Functions

static Standard_EXPORT void DumpBox (Standard_OStream &S, const Bnd_Box2d &abox)

Protected Member Functions

Standard_EXPORT Select3D_SensitiveEntity (const Handle(SelectBasics_EntityOwner)&OwnerId)
Standard_EXPORT void SetLastDepth (const Standard_Real aDepth)

Protected Attributes

Standard_Address mylastprj

Private Attributes

Standard_ShortReal mylastdepth

Constructor & Destructor Documentation

Standard_EXPORT Select3D_SensitiveEntity::Select3D_SensitiveEntity const Handle(SelectBasics_EntityOwner)&  OwnerId  )  [protected]
 


Member Function Documentation

virtual Standard_EXPORT Standard_Real Select3D_SensitiveEntity::ComputeDepth const gp_Lin &  EyeLine  )  const [pure virtual]
 

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

virtual Standard_EXPORT Standard_Real Select3D_SensitiveEntity::Depth  )  const [virtual]
 

Reimplemented from SelectBasics_SensitiveEntity.

virtual Standard_EXPORT void Select3D_SensitiveEntity::Dump Standard_OStream &  S,
const Standard_Boolean  FullDump = Standard_True
const [virtual]
 

Reimplemented in Select3D_SensitiveBox, Select3D_SensitiveCircle, Select3D_SensitiveCurve, Select3D_SensitiveFace, Select3D_SensitivePoint, Select3D_SensitiveSegment, Select3D_SensitiveTriangle, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

static Standard_EXPORT void Select3D_SensitiveEntity::DumpBox Standard_OStream &  S,
const Bnd_Box2d &  abox
[static]
 

virtual Standard_EXPORT Handle_Select3D_SensitiveEntity Select3D_SensitiveEntity::GetConnected const TopLoc_Location &  aLocation  )  [virtual]
 

Reimplemented in MeshVS_SensitiveMesh, MeshVS_SensitivePolyhedron, Select3D_SensitiveBox, Select3D_SensitiveGroup, Select3D_SensitivePoint, Select3D_SensitiveSegment, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

Standard_EXPORT gp_Lin Select3D_SensitiveEntity::GetEyeLine const Standard_Real  X,
const Standard_Real  Y
const
 

Standard_EXPORT const Select3D_SensitiveEntity::Handle Standard_Type   )  const
 

Reimplemented from SelectBasics_SensitiveEntity.

Reimplemented in MeshVS_SensitiveFace, MeshVS_SensitiveMesh, MeshVS_SensitivePolyhedron, MeshVS_SensitiveSegment, Select3D_SensitiveBox, Select3D_SensitiveCircle, Select3D_SensitiveCurve, Select3D_SensitiveFace, Select3D_SensitiveGroup, Select3D_SensitivePoint, Select3D_SensitivePoly, Select3D_SensitiveSegment, Select3D_SensitiveTriangle, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

virtual Standard_EXPORT Standard_Boolean Select3D_SensitiveEntity::HasLocation  )  const [virtual]
 

Standard_EXPORT Standard_Boolean Select3D_SensitiveEntity::Is3D  )  const [virtual]
 

Implements SelectBasics_SensitiveEntity.

virtual Standard_EXPORT const TopLoc_Location& Select3D_SensitiveEntity::Location  )  const [virtual]
 

virtual Standard_EXPORT Standard_Boolean Select3D_SensitiveEntity::Matches const TColgp_Array1OfPnt2d &  Polyline,
const Bnd_Box2d &  aBox,
const Standard_Real  aTol
[virtual]
 

Implements SelectBasics_SensitiveEntity.

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

virtual Standard_EXPORT Standard_Boolean Select3D_SensitiveEntity::Matches const Standard_Real  XMin,
const Standard_Real  YMin,
const Standard_Real  XMax,
const Standard_Real  YMax,
const Standard_Real  aTol
[virtual]
 

Implements SelectBasics_SensitiveEntity.

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

virtual Standard_EXPORT Standard_Boolean Select3D_SensitiveEntity::Matches const Standard_Real  X,
const Standard_Real  Y,
const Standard_Real  aTol,
Standard_Real &  DMin
[virtual]
 

Implements SelectBasics_SensitiveEntity.

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

virtual Standard_EXPORT Standard_Integer Select3D_SensitiveEntity::MaxBoxes  )  const [virtual]
 

Implements SelectBasics_SensitiveEntity.

Reimplemented in Select3D_SensitiveGroup, Select3D_SensitiveSegment, and Select3D_SensitiveWire.

Standard_Boolean Select3D_SensitiveEntity::NeedsConversion  )  const [inline, virtual]
 

Implements SelectBasics_SensitiveEntity.

virtual Standard_EXPORT void Select3D_SensitiveEntity::Project const Select3D_Projector aProjector  )  [virtual]
 

Reimplemented in MeshVS_SensitiveFace, MeshVS_SensitiveMesh, MeshVS_SensitivePolyhedron, MeshVS_SensitiveSegment, Select3D_SensitiveBox, Select3D_SensitiveGroup, Select3D_SensitivePoint, Select3D_SensitivePoly, Select3D_SensitiveSegment, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

virtual Standard_EXPORT void Select3D_SensitiveEntity::ResetLocation  )  [virtual]
 

Reimplemented in Select3D_SensitiveGroup, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

Standard_EXPORT void Select3D_SensitiveEntity::SetLastDepth const Standard_Real  aDepth  )  [protected]
 

virtual Standard_EXPORT void Select3D_SensitiveEntity::SetLastPrj const Select3D_Projector aPrj  )  [virtual]
 

Reimplemented in Select3D_SensitiveGroup, and Select3D_SensitiveWire.

virtual Standard_EXPORT void Select3D_SensitiveEntity::SetLocation const TopLoc_Location &  aLoc  )  [virtual]
 

Reimplemented in Select3D_SensitiveGroup, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

Standard_EXPORT void Select3D_SensitiveEntity::UpdateLocation const TopLoc_Location &  aLoc  ) 
 


Field Documentation

Standard_ShortReal Select3D_SensitiveEntity::mylastdepth [private]
 

Standard_Address Select3D_SensitiveEntity::mylastprj [protected]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:56:12 2008 for OpenCASCADE by  doxygen 1.4.1