Open CASCADE Technology  6.8.0
Public Member Functions
Select3D_SensitiveBox Class Reference

A framework to define selection by a sensitive box. More...

#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. More...
 
 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. More...
 
void Project (const Handle< Select3D_Projector > &aProjector)
 projection of the sensitive primitive in order to get 2D boxes for the Sort Algorithm More...
 
void Areas (SelectBasics_ListOfBox2d &boxes)
 gives the 2D boxes which represent the Box in the selection process... More...
 
Handle< Select3D_SensitiveEntityGetConnected (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. More...
 
Standard_Boolean Matches (const SelectBasics_PickArgs &thePickArgs, Standard_Real &theMatchDMin, Standard_Real &theMatchDepth)
 Checks whether the sensitive entity matches the picking detection area (close to the picking line). For details please refer to base class declaration. More...
 
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. More...
 
virtual Standard_Boolean Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
 prevents from hiding virtual methods... More...
 
Standard_Real ComputeDepth (const gp_Lin &EyeLine) const
 
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...
 
const Bnd_BoxBox () const
 Returns the sensitive 3D box used at the time of construction. 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)
 
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_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Select3D_SensitiveEntity
static void DumpBox (Standard_OStream &S, const Bnd_Box2d &abox)
 
- 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)
 
- Protected Attributes inherited from SelectBasics_SensitiveEntity
Handle< SelectBasics_EntityOwnermyOwnerId
 

Detailed Description

A framework to define selection by a sensitive box.

Constructor & Destructor Documentation

Select3D_SensitiveBox::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::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.

Member Function Documentation

void Select3D_SensitiveBox::Areas ( SelectBasics_ListOfBox2d boxes)
virtual

gives the 2D boxes which represent the Box in the selection process...

Implements SelectBasics_SensitiveEntity.

const Bnd_Box& Select3D_SensitiveBox::Box ( ) const

Returns the sensitive 3D box used at the time of construction.

Standard_Real Select3D_SensitiveBox::ComputeDepth ( const gp_Lin EyeLine) const
virtual void Select3D_SensitiveBox::Dump ( Standard_OStream S,
const Standard_Boolean  FullDump = Standard_True 
) const
virtual

2 options : <FullDump> = False -> general information <FullDump> = True -> whole informtion 3D +2d ...

Reimplemented from Select3D_SensitiveEntity.

Handle< Select3D_SensitiveEntity > Select3D_SensitiveBox::GetConnected ( const TopLoc_Location aLocation)
virtual

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.

Reimplemented from Select3D_SensitiveEntity.

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

Checks whether the sensitive entity matches the picking detection area (close to the picking line). For details please refer to base class declaration.

Implements SelectBasics_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

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.

Reimplemented from Select3D_SensitiveEntity.

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

prevents from hiding virtual methods...

Reimplemented from Select3D_SensitiveEntity.

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

projection of the sensitive primitive in order to get 2D boxes for the Sort Algorithm

Implements Select3D_SensitiveEntity.


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