Open CASCADE Technology 6.6.0
Public Member Functions
Select3D_SensitiveBox Class Reference

A framework to define selection by a sensitive box.

#include <Select3D_SensitiveBox.hxx>

Inheritance diagram for Select3D_SensitiveBox:
Inheritance graph
[legend]

Public Member Functions

 Select3D_SensitiveBox (const Handle< SelectBasics_EntityOwner > &OwnerId, const Bnd_Box &BoundingBox)
 Constructs a sensitive box object defined by the
owner OwnerId, and the bounding box BoundingBox.

 Select3D_SensitiveBox (const Handle< SelectBasics_EntityOwner > &OwnerId, const Standard_Real XMin, const Standard_Real YMin, const Standard_Real ZMin, const Standard_Real XMax, const Standard_Real YMax, const Standard_Real ZMax)
 Constructs a sensitive box object defined by the
owner OwnerId, and the coordinates Xmin, YMin, ZMin, XMax, YMax, ZMax.
Xmin, YMin and ZMin define the minimum point in
the front lower left hand corner of the box,
and XMax, YMax and ZMax define the maximum
point in the back upper right hand corner of the box.

void Project (const Handle< Select3D_Projector > &aProjector)
 projection of the sensitive primitive in order to
get 2D boxes for the Sort Algorithm

void Areas (SelectBasics_ListOfBox2d &boxes)
 gives the 2D boxes which represent the Box in the
selection process...

Handle_Select3D_SensitiveEntity GetConnected (const TopLoc_Location &aLocation)
 Originally this method intended to return sensitive
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.

Standard_Boolean Matches (const Standard_Real X, const Standard_Real Y, const Standard_Real aTol, Standard_Real &DMin)
 

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_Boolean Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
 prevents from hiding virtual methods...

Standard_Real ComputeDepth (const gp_Lin &EyeLine) const
 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 void Dump (Standard_OStream &S, const Standard_Boolean FullDump=Standard_True) const
 2 options :
<FullDump> = False -> general information
<FullDump> = True -> whole informtion 3D +2d ...

const Bnd_BoxBox () const
 Returns the sensitive 3D box used at the time of construction.


Constructor & Destructor Documentation

Select3D_SensitiveBox::Select3D_SensitiveBox ( const Handle< SelectBasics_EntityOwner > &  OwnerId,
const Bnd_Box BoundingBox 
)
Select3D_SensitiveBox::Select3D_SensitiveBox ( const Handle< SelectBasics_EntityOwner > &  OwnerId,
const Standard_Real  XMin,
const Standard_Real  YMin,
const Standard_Real  ZMin,
const Standard_Real  XMax,
const Standard_Real  YMax,
const Standard_Real  ZMax 
)

Member Function Documentation

void Select3D_SensitiveBox::Areas ( SelectBasics_ListOfBox2d boxes) [virtual]
const Bnd_Box& Select3D_SensitiveBox::Box ( ) const
Standard_Real Select3D_SensitiveBox::ComputeDepth ( const gp_Lin EyeLine) const [virtual]
virtual void Select3D_SensitiveBox::Dump ( Standard_OStream S,
const Standard_Boolean  FullDump = Standard_True 
) const [virtual]

Reimplemented from Select3D_SensitiveEntity.

Handle_Select3D_SensitiveEntity Select3D_SensitiveBox::GetConnected ( const TopLoc_Location aLocation) [virtual]

Reimplemented from Select3D_SensitiveEntity.

Standard_Boolean Select3D_SensitiveBox::Matches ( const Standard_Real  XMin,
const Standard_Real  YMin,
const Standard_Real  XMax,
const Standard_Real  YMax,
const Standard_Real  aTol 
) [virtual]

Reimplemented from Select3D_SensitiveEntity.

Standard_Boolean Select3D_SensitiveBox::Matches ( const Standard_Real  X,
const Standard_Real  Y,
const Standard_Real  aTol,
Standard_Real DMin 
) [virtual]

Reimplemented from Select3D_SensitiveEntity.

virtual Standard_Boolean Select3D_SensitiveBox::Matches ( const TColgp_Array1OfPnt2d Polyline,
const Bnd_Box2d aBox,
const Standard_Real  aTol 
) [virtual]

Reimplemented from Select3D_SensitiveEntity.

void Select3D_SensitiveBox::Project ( const Handle< Select3D_Projector > &  aProjector) [virtual]

Reimplemented from Select3D_SensitiveEntity.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines