Open CASCADE Technology  7.7.0
Public Member Functions

Select3D_SensitiveCircle Class Reference

A framework to define sensitive 3D circles. More...

#include <Select3D_SensitiveCircle.hxx>

Inheritance diagram for Select3D_SensitiveCircle:
Inheritance graph
[legend]

Public Member Functions

 Select3D_SensitiveCircle (const Handle< SelectMgr_EntityOwner > &theOwnerId, const gp_Circ &theCircle, const Standard_Boolean theIsFilled=Standard_False)
 Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle and the boolean theIsFilled. More...
 
 Select3D_SensitiveCircle (const Handle< SelectMgr_EntityOwner > &theOwnerId, const gp_Circ &theCircle, const Standard_Boolean theIsFilled, const Standard_Integer)
 Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle, the boolean theIsFilled and the number of points theNbPnts. More...
 
virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
 Checks whether the circle overlaps current selecting volume. More...
 
virtual Handle< Select3D_SensitiveEntityGetConnected () override
 Returns a copy of this sensitive circle. More...
 
virtual Select3D_BndBox3d BoundingBox () override
 Returns bounding box of the circle. 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 circle with transformation applied. More...
 
const gp_TrsfTransformation () const
 The transformation for gp::XOY() with center in gp::Origin(), it specifies the position and orientation of the circle. More...
 
gp_Circ Circle () const
 Returns circle. More...
 
Standard_Real Radius () const
 Returns circle radius. 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...
 

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
 
Handle< Graphic3d_TransformPersmyTrsfPers
 
Standard_Integer mySFactor
 

Detailed Description

A framework to define sensitive 3D circles.

Constructor & Destructor Documentation

◆ Select3D_SensitiveCircle() [1/2]

Select3D_SensitiveCircle::Select3D_SensitiveCircle ( const Handle< SelectMgr_EntityOwner > &  theOwnerId,
const gp_Circ theCircle,
const Standard_Boolean  theIsFilled = Standard_False 
)

Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle and the boolean theIsFilled.

◆ Select3D_SensitiveCircle() [2/2]

Select3D_SensitiveCircle::Select3D_SensitiveCircle ( const Handle< SelectMgr_EntityOwner > &  theOwnerId,
const gp_Circ theCircle,
const Standard_Boolean  theIsFilled,
const  Standard_Integer 
)
inline

Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle, the boolean theIsFilled and the number of points theNbPnts.

Deprecated:
("Deprecated constructor, theNbPnts parameter will be ignored")

Member Function Documentation

◆ BoundingBox()

virtual Select3D_BndBox3d Select3D_SensitiveCircle::BoundingBox ( )
overridevirtual

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

Implements Select3D_SensitiveEntity.

◆ CenterOfGeometry()

virtual gp_Pnt Select3D_SensitiveCircle::CenterOfGeometry ( ) const
overridevirtual

Returns center of the circle with transformation applied.

Implements Select3D_SensitiveEntity.

◆ Circle()

gp_Circ Select3D_SensitiveCircle::Circle ( ) const
inline

Returns circle.

◆ GetConnected()

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

Returns a copy of this sensitive circle.

Reimplemented from Select3D_SensitiveEntity.

◆ Matches()

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

Checks whether the circle overlaps current selecting volume.

Implements Select3D_SensitiveEntity.

◆ NbSubElements()

virtual Standard_Integer Select3D_SensitiveCircle::NbSubElements ( ) const
inlineoverridevirtual

Returns the amount of points.

Implements Select3D_SensitiveEntity.

◆ Radius()

Standard_Real Select3D_SensitiveCircle::Radius ( ) const
inline

Returns circle radius.

◆ ToBuildBVH()

virtual Standard_Boolean Select3D_SensitiveCircle::ToBuildBVH ( ) const
inlineoverridevirtual

Always returns Standard_False.

Reimplemented from Select3D_SensitiveEntity.

◆ Transformation()

const gp_Trsf& Select3D_SensitiveCircle::Transformation ( ) const
inline

The transformation for gp::XOY() with center in gp::Origin(), it specifies the position and orientation of the circle.


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