Open CASCADE Technology  7.4.1.dev
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< SelectMgr_EntityOwner > &theOwnerId, const Bnd_Box &theBox)
 Constructs a sensitive box object defined by the owner theOwnerId, and the box theBox. More...
 
 Select3D_SensitiveBox (const Handle< SelectMgr_EntityOwner > &theOwnerId, const Standard_Real theXMin, const Standard_Real theYMin, const Standard_Real theZMin, const Standard_Real theXMax, const Standard_Real theYMax, const Standard_Real theZMax)
 Constructs a sensitive box object defined by the owner theOwnerId, and the coordinates theXmin, theYMin, theZMin, theXMax, theYMax, theZMax. theXmin, theYMin and theZMin define the minimum point in the front lower left hand corner of the box, and theXMax, theYMax and theZMax define the maximum point in the back upper right hand corner of the box. More...
 
virtual Standard_Integer NbSubElements () const override
 Returns the amount of sub-entities in sensitive. More...
 
virtual Handle< Select3D_SensitiveEntityGetConnected () override
 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. More...
 
virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
 Checks whether the box overlaps current selecting volume. More...
 
Bnd_Box Box () const
 
virtual gp_Pnt CenterOfGeometry () const override
 Returns center of the box. If location transformation is set, it will be applied. More...
 
virtual Select3D_BndBox3d BoundingBox () override
 Returns coordinates of the box. If location transformation is set, it will be applied. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Select3D_SensitiveEntity
const Handle< SelectMgr_EntityOwner > & OwnerId () const
 Returns pointer to owner of the entity. More...
 
virtual void Set (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 Sets owner of the entity. More...
 
Standard_Integer SensitivityFactor () const
 allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities. More...
 
void SetSensitivityFactor (const Standard_Integer theNewSens)
 Allows to manage sensitivity of a particular sensitive entity. More...
 
virtual void BVH ()
 Builds BVH tree for a sensitive if needed. More...
 
virtual void Clear ()
 Clears up all resources and memory. More...
 
virtual Standard_Boolean HasInitLocation () const
 Returns true if the shape corresponding to the entity has init location. More...
 
virtual gp_GTrsf InvInitLocation () const
 Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix. 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 void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::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 opencascade::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...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from Select3D_SensitiveEntity
 Select3D_SensitiveEntity (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 
- Protected Attributes inherited from Select3D_SensitiveEntity
Handle< SelectMgr_EntityOwnermyOwnerId
 
Standard_Integer mySFactor
 

Detailed Description

A framework to define selection by a sensitive box.

Constructor & Destructor Documentation

◆ Select3D_SensitiveBox() [1/2]

Select3D_SensitiveBox::Select3D_SensitiveBox ( const Handle< SelectMgr_EntityOwner > &  theOwnerId,
const Bnd_Box theBox 
)

Constructs a sensitive box object defined by the owner theOwnerId, and the box theBox.

◆ Select3D_SensitiveBox() [2/2]

Select3D_SensitiveBox::Select3D_SensitiveBox ( const Handle< SelectMgr_EntityOwner > &  theOwnerId,
const Standard_Real  theXMin,
const Standard_Real  theYMin,
const Standard_Real  theZMin,
const Standard_Real  theXMax,
const Standard_Real  theYMax,
const Standard_Real  theZMax 
)

Constructs a sensitive box object defined by the owner theOwnerId, and the coordinates theXmin, theYMin, theZMin, theXMax, theYMax, theZMax. theXmin, theYMin and theZMin define the minimum point in the front lower left hand corner of the box, and theXMax, theYMax and theZMax define the maximum point in the back upper right hand corner of the box.

Member Function Documentation

◆ BoundingBox()

virtual Select3D_BndBox3d Select3D_SensitiveBox::BoundingBox ( )
overridevirtual

Returns coordinates of the box. If location transformation is set, it will be applied.

Implements Select3D_SensitiveEntity.

◆ Box()

Bnd_Box Select3D_SensitiveBox::Box ( ) const
inline

◆ CenterOfGeometry()

virtual gp_Pnt Select3D_SensitiveBox::CenterOfGeometry ( ) const
overridevirtual

Returns center of the box. If location transformation is set, it will be applied.

Implements Select3D_SensitiveEntity.

◆ DumpJson()

virtual void Select3D_SensitiveBox::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from Select3D_SensitiveEntity.

◆ GetConnected()

virtual Handle< Select3D_SensitiveEntity > Select3D_SensitiveBox::GetConnected ( )
overridevirtual

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.

Reimplemented from Select3D_SensitiveEntity.

◆ Matches()

virtual Standard_Boolean Select3D_SensitiveBox::Matches ( SelectBasics_SelectingVolumeManager theMgr,
SelectBasics_PickResult thePickResult 
)
overridevirtual

Checks whether the box overlaps current selecting volume.

Implements Select3D_SensitiveEntity.

◆ NbSubElements()

virtual Standard_Integer Select3D_SensitiveBox::NbSubElements ( ) const
overridevirtual

Returns the amount of sub-entities in sensitive.

Implements Select3D_SensitiveEntity.


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