Open CASCADE Technology  7.7.0
Public Member Functions | Protected Attributes

Select3D_SensitiveCylinder Class Reference

A framework to define selection by a sensitive cylinder or cone. More...

#include <Select3D_SensitiveCylinder.hxx>

Inheritance diagram for Select3D_SensitiveCylinder:
Inheritance graph
[legend]

Public Member Functions

 Select3D_SensitiveCylinder (const Handle< SelectMgr_EntityOwner > &theOwnerId, const Standard_Real theBottomRad, const Standard_Real theTopRad, const Standard_Real theHeight, const gp_Trsf &theTrsf, const Standard_Boolean theIsHollow=Standard_False)
 Constructs a sensitive cylinder object defined by the owner theOwnerId,. More...
 
virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
 Checks whether the cylinder overlaps current selecting volume. More...
 
virtual Handle< Select3D_SensitiveEntityGetConnected () override
 Returns the copy of this. More...
 
virtual Select3D_BndBox3d BoundingBox () override
 Returns bounding box of the cylinder. If location transformation is set, it will be applied. More...
 
virtual Standard_Boolean ToBuildBVH () const override
 Always returns Standard_False. More...
 
virtual Standard_Integer NbSubElements () const override
 Returns the amount of points. More...
 
virtual gp_Pnt CenterOfGeometry () const override
 Returns center of the cylinder with transformation applied. More...
 
const gp_TrsfTransformation () const
 Returns cylinder transformation. More...
 
Standard_Real TopRadius () const
 Returns cylinder top radius. More...
 
Standard_Real BottomRadius () const
 Returns cylinder bottom radius. More...
 
Standard_Real Height () const
 Returns cylinder height. More...
 
Standard_Boolean IsHollow () const
 Returns true if the cylinder is empty inside. 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...
 
const Handle< Graphic3d_TransformPers > & TransformPersistence () const
 Return transformation persistence. More...
 
virtual void SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers)
 Set transformation persistence. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. 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...
 

Protected Attributes

gp_Trsf myTrsf
 cylinder transformation to apply More...
 
Standard_Real myBottomRadius
 cylinder bottom radius More...
 
Standard_Real myTopRadius
 cylinder top radius More...
 
Standard_Real myHeight
 cylinder height More...
 
Standard_Boolean myIsHollow
 true if the cylinder is empty inside More...
 
- Protected Attributes inherited from Select3D_SensitiveEntity
Handle< SelectMgr_EntityOwnermyOwnerId
 
Handle< Graphic3d_TransformPersmyTrsfPers
 
Standard_Integer mySFactor
 

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)
 

Detailed Description

A framework to define selection by a sensitive cylinder or cone.

Constructor & Destructor Documentation

◆ Select3D_SensitiveCylinder()

Select3D_SensitiveCylinder::Select3D_SensitiveCylinder ( const Handle< SelectMgr_EntityOwner > &  theOwnerId,
const Standard_Real  theBottomRad,
const Standard_Real  theTopRad,
const Standard_Real  theHeight,
const gp_Trsf theTrsf,
const Standard_Boolean  theIsHollow = Standard_False 
)

Constructs a sensitive cylinder object defined by the owner theOwnerId,.

Parameters
[in]theBottomRadcylinder bottom radius
[in]theTopRadcylinder top radius
[in]theHeightcylinder height

Member Function Documentation

◆ BottomRadius()

Standard_Real Select3D_SensitiveCylinder::BottomRadius ( ) const
inline

Returns cylinder bottom radius.

◆ BoundingBox()

virtual Select3D_BndBox3d Select3D_SensitiveCylinder::BoundingBox ( )
overridevirtual

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

Implements Select3D_SensitiveEntity.

◆ CenterOfGeometry()

virtual gp_Pnt Select3D_SensitiveCylinder::CenterOfGeometry ( ) const
overridevirtual

Returns center of the cylinder with transformation applied.

Implements Select3D_SensitiveEntity.

◆ GetConnected()

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

Returns the copy of this.

Reimplemented from Select3D_SensitiveEntity.

◆ Height()

Standard_Real Select3D_SensitiveCylinder::Height ( ) const
inline

Returns cylinder height.

◆ IsHollow()

Standard_Boolean Select3D_SensitiveCylinder::IsHollow ( ) const
inline

Returns true if the cylinder is empty inside.

◆ Matches()

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

Checks whether the cylinder overlaps current selecting volume.

Implements Select3D_SensitiveEntity.

◆ NbSubElements()

virtual Standard_Integer Select3D_SensitiveCylinder::NbSubElements ( ) const
inlineoverridevirtual

Returns the amount of points.

Implements Select3D_SensitiveEntity.

◆ ToBuildBVH()

virtual Standard_Boolean Select3D_SensitiveCylinder::ToBuildBVH ( ) const
inlineoverridevirtual

Always returns Standard_False.

Reimplemented from Select3D_SensitiveEntity.

◆ TopRadius()

Standard_Real Select3D_SensitiveCylinder::TopRadius ( ) const
inline

Returns cylinder top radius.

◆ Transformation()

const gp_Trsf& Select3D_SensitiveCylinder::Transformation ( ) const
inline

Returns cylinder transformation.

Field Documentation

◆ myBottomRadius

Standard_Real Select3D_SensitiveCylinder::myBottomRadius
protected

cylinder bottom radius

◆ myHeight

Standard_Real Select3D_SensitiveCylinder::myHeight
protected

cylinder height

◆ myIsHollow

Standard_Boolean Select3D_SensitiveCylinder::myIsHollow
protected

true if the cylinder is empty inside

◆ myTopRadius

Standard_Real Select3D_SensitiveCylinder::myTopRadius
protected

cylinder top radius

◆ myTrsf

gp_Trsf Select3D_SensitiveCylinder::myTrsf
protected

cylinder transformation to apply


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