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:

Public Member Functions
	Select3D_SensitiveCylinder (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const bool theIsHollow=false)
	Constructs a sensitive cylinder object defined by the owner theOwnerId,.
bool	Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
	Checks whether the cylinder overlaps current selecting volume.
occ::handle< Select3D_SensitiveEntity >	GetConnected () override
	Returns the copy of this.
Select3D_BndBox3d	BoundingBox () override
	Returns bounding box of the cylinder. If location transformation is set, it will be applied.
bool	ToBuildBVH () const override
	Always returns false.
int	NbSubElements () const override
	Returns the amount of points.
gp_Pnt	CenterOfGeometry () const override
	Returns center of the cylinder with transformation applied.
const gp_Trsf &	Transformation () const
	Returns cylinder transformation.
double	TopRadius () const
	Returns cylinder top radius.
double	BottomRadius () const
	Returns cylinder bottom radius.
double	Height () const
	Returns cylinder height.
bool	IsHollow () const
	Returns true if the cylinder is empty inside.
Public Member Functions inherited from Select3D_SensitiveEntity
const occ::handle< SelectMgr_EntityOwner > &	OwnerId () const
	Returns pointer to owner of the entity.
virtual void	Set (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
	Sets owner of the entity.
int	SensitivityFactor () const
	allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities.
void	SetSensitivityFactor (const int theNewSens)
	Allows to manage sensitivity of a particular sensitive entity.
virtual void	BVH ()
	Builds BVH tree for a sensitive if needed.
virtual void	Clear ()
	Clears up all resources and memory.
virtual bool	HasInitLocation () const
	Returns true if the shape corresponding to the entity has init location.
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.
const occ::handle< Graphic3d_TransformPers > &	TransformPersistence () const
	Return transformation persistence.
virtual void	SetTransformPersistence (const occ::handle< Graphic3d_TransformPers > &theTrsfPers)
	Set transformation persistence.
const occ::handle< Graphic3d_Flipper > &	Flipper () const
	Return flipper metadata describing the runtime flip of the owning group, or null.
virtual void	SetFlippingOptions (const bool theIsEnabled, const gp_Ax2 &theRefPlane)
	Set flipping options. When enabled, creates a Graphic3d_Flipper for theRefPlane; otherwise clears the flipper.
virtual void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	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.
bool	IsKind (const char *const 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.
Standard_Transient *	This () 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.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Attributes
gp_Trsf	myTrsf
	cylinder transformation to apply
double	myBottomRadius
	cylinder bottom radius
double	myTopRadius
	cylinder top radius
double	myHeight
	cylinder height
bool	myIsHollow
	true if the cylinder is empty inside
Protected Attributes inherited from Select3D_SensitiveEntity
occ::handle< SelectMgr_EntityOwner >	myOwnerId
occ::handle< Graphic3d_TransformPers >	myTrsfPers
occ::handle< Graphic3d_Flipper >	myFlipper
int	mySFactor

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.
Protected Member Functions inherited from Select3D_SensitiveEntity
	Select3D_SensitiveEntity (const occ::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 occ::handle< SelectMgr_EntityOwner > &	theOwnerId,
		const double	theBottomRad,
		const double	theTopRad,
		const double	theHeight,
		const gp_Trsf &	theTrsf,
		const bool	theIsHollow = false )

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

Parameters

[in]	theBottomRad	cylinder bottom radius
[in]	theTopRad	cylinder top radius
[in]	theHeight	cylinder height

Member Function Documentation

BottomRadius()

double Select3D_SensitiveCylinder::BottomRadius ( ) const

inline

Returns cylinder bottom radius.

BoundingBox()

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()

gp_Pnt Select3D_SensitiveCylinder::CenterOfGeometry ( ) const

overridevirtual

Returns center of the cylinder with transformation applied.

Implements Select3D_SensitiveEntity.

GetConnected()

occ::handle< Select3D_SensitiveEntity > Select3D_SensitiveCylinder::GetConnected ( )

overridevirtual

Returns the copy of this.

Reimplemented from Select3D_SensitiveEntity.

Height()

double Select3D_SensitiveCylinder::Height ( ) const

inline

Returns cylinder height.

IsHollow()

bool Select3D_SensitiveCylinder::IsHollow ( ) const

inline

Returns true if the cylinder is empty inside.

Matches()

bool Select3D_SensitiveCylinder::Matches ( SelectBasics_SelectingVolumeManager & theMgr, SelectBasics_PickResult & thePickResult )

overridevirtual

Checks whether the cylinder overlaps current selecting volume.

Implements Select3D_SensitiveEntity.

NbSubElements()

int Select3D_SensitiveCylinder::NbSubElements ( ) const

inlineoverridevirtual

Returns the amount of points.

Implements Select3D_SensitiveEntity.

ToBuildBVH()

bool Select3D_SensitiveCylinder::ToBuildBVH ( ) const

inlineoverridevirtual

Always returns false.

Reimplemented from Select3D_SensitiveEntity.

TopRadius()

double Select3D_SensitiveCylinder::TopRadius ( ) const

inline

Returns cylinder top radius.

Transformation()

const gp_Trsf & Select3D_SensitiveCylinder::Transformation ( ) const

inline

Returns cylinder transformation.

Field Documentation

myBottomRadius

double Select3D_SensitiveCylinder::myBottomRadius

protected

cylinder bottom radius

myHeight

double Select3D_SensitiveCylinder::myHeight

protected

cylinder height

myIsHollow

bool Select3D_SensitiveCylinder::myIsHollow

protected

true if the cylinder is empty inside

myTopRadius

double 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:

• Select3D_SensitiveCylinder.hxx