Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions
AIS_ViewCubeSensitive Class Reference

Simple sensitive element for picking by point only. More...

#include <AIS_ViewCube.hxx>

Inheritance diagram for AIS_ViewCubeSensitive:
Inheritance graph
[legend]

Public Member Functions

 AIS_ViewCubeSensitive (const occ::handle< SelectMgr_EntityOwner > &theOwner, const occ::handle< Graphic3d_ArrayOfTriangles > &theTris)
 Constructor.
 
bool Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
 Checks whether element overlaps current selecting volume.
 
- Public Member Functions inherited from Select3D_SensitivePrimitiveArray
 Select3D_SensitivePrimitiveArray (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
 Constructs an empty sensitive object.
 
int PatchSizeMax () const
 Return patch size limit (1 by default).
 
void SetPatchSizeMax (const int thePatchSizeMax)
 Assign patch size limit. Should be set before initialization.
 
float PatchDistance () const
 Maximum allowed distance between consequential elements in patch (ShortRealLast() by default). Has no effect on indexed triangulation.
 
void SetPatchDistance (const float thePatchDistMax)
 Assign patch distance limit. Should be set before initialization.
 
bool InitTriangulation (const occ::handle< Graphic3d_Buffer > &theVerts, const occ::handle< Graphic3d_IndexBuffer > &theIndices, const TopLoc_Location &theInitLoc, const int theIndexLower, const int theIndexUpper, const bool theToEvalMinMax=true, const int theNbGroups=1)
 Initialize the sensitive object from triangualtion. The sub-triangulation can be specified by arguments theIndexLower and theIndexUpper (these are for iterating theIndices, not to restrict the actual index values!).
 
bool InitTriangulation (const occ::handle< Graphic3d_Buffer > &theVerts, const occ::handle< Graphic3d_IndexBuffer > &theIndices, const TopLoc_Location &theInitLoc, const bool theToEvalMinMax=true, const int theNbGroups=1)
 Initialize the sensitive object from triangualtion.
 
bool InitPoints (const occ::handle< Graphic3d_Buffer > &theVerts, const occ::handle< Graphic3d_IndexBuffer > &theIndices, const TopLoc_Location &theInitLoc, const int theIndexLower, const int theIndexUpper, const bool theToEvalMinMax=true, const int theNbGroups=1)
 Initialize the sensitive object from point set. The sub-set of points can be specified by arguments theIndexLower and theIndexUpper (these are for iterating theIndices, not to restrict the actual index values!).
 
bool InitPoints (const occ::handle< Graphic3d_Buffer > &theVerts, const occ::handle< Graphic3d_IndexBuffer > &theIndices, const TopLoc_Location &theInitLoc, const bool theToEvalMinMax=true, const int theNbGroups=1)
 Initialize the sensitive object from point set.
 
bool InitPoints (const occ::handle< Graphic3d_Buffer > &theVerts, const TopLoc_Location &theInitLoc, const bool theToEvalMinMax=true, const int theNbGroups=1)
 Initialize the sensitive object from point set.
 
void SetMinMax (double theMinX, double theMinY, double theMinZ, double theMaxX, double theMaxY, double theMaxZ)
 Assign new not transformed bounding box.
 
bool ToDetectElements () const
 Return flag to keep index of last topmost detected element, TRUE by default.
 
void SetDetectElements (bool theToDetect)
 Setup keeping of the index of last topmost detected element (axis picking).
 
bool ToDetectElementMap () const
 Return flag to keep index map of last detected elements, FALSE by default (rectangle selection).
 
void SetDetectElementMap (bool theToDetect)
 Setup keeping of the index map of last detected elements (rectangle selection).
 
bool ToDetectNodes () const
 Return flag to keep index of last topmost detected node, FALSE by default.
 
void SetDetectNodes (bool theToDetect)
 Setup keeping of the index of last topmost detected node (for axis picking).
 
bool ToDetectNodeMap () const
 Return flag to keep index map of last detected nodes, FALSE by default (rectangle selection).
 
void SetDetectNodeMap (bool theToDetect)
 Setup keeping of the index map of last detected nodes (rectangle selection).
 
bool ToDetectEdges () const
 Return flag to keep index of last topmost detected edge, FALSE by default.
 
void SetDetectEdges (bool theToDetect)
 Setup keeping of the index of last topmost detected edge (axis picking).
 
int LastDetectedElement () const
 Return last topmost detected element or -1 if undefined (axis picking).
 
const occ::handle< TColStd_HPackedMapOfInteger > & LastDetectedElementMap () const
 Return the index map of last detected elements (rectangle selection).
 
int LastDetectedNode () const
 Return last topmost detected node or -1 if undefined (axis picking).
 
const occ::handle< TColStd_HPackedMapOfInteger > & LastDetectedNodeMap () const
 Return the index map of last detected nodes (rectangle selection).
 
int LastDetectedEdgeNode1 () const
 Return the first node of last topmost detected edge or -1 if undefined (axis picking).
 
int LastDetectedEdgeNode2 () const
 Return the second node of last topmost detected edge or -1 if undefined (axis picking).
 
std::array< NCollection_Vec3< float >, 3 > GetVertex (const int theIndex) const
 Return the three vertex positions of the triangle at the given triangulation index. Only meaningful for triangulation-based primitive arrays.
 
void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
 Dumps the content of me into the stream.
 
bool Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
 Checks whether the sensitive entity is overlapped by current selecting volume.
 
occ::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.
 
int Size () const override
 Returns the length of array of triangles or edges.
 
int NbSubElements () const override
 Returns the amount of nodes in triangulation.
 
Select3D_BndBox3d Box (const int theIdx) const override
 Returns bounding box of triangle/edge with index theIdx.
 
double Center (const int theIdx, const int theAxis) const override
 Returns geometry center of triangle/edge with index theIdx in array along the given axis theAxis.
 
void Swap (const int theIdx1, const int theIdx2) override
 Swaps items with indexes theIdx1 and theIdx2 in array.
 
Select3D_BndBox3d BoundingBox () override
 Returns bounding box of the triangulation. If location transformation is set, it will be applied.
 
gp_Pnt CenterOfGeometry () const override
 Returns center of triangulation. If location transformation is set, it will be applied.
 
bool HasInitLocation () const override
 Returns true if the shape corresponding to the entity has init location.
 
gp_GTrsf InvInitLocation () const override
 Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.
 
void Set (const occ::handle< SelectMgr_EntityOwner > &theOwnerId) override
 Sets the owner for all entities in group.
 
void BVH () override
 Builds BVH tree for sensitive set.
 
- Public Member Functions inherited from Select3D_SensitiveSet
 Select3D_SensitiveSet (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
 Creates new empty sensitive set and its content.
 
bool Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
 Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set.
 
void BVH () override
 Builds BVH tree for sensitive set. Must be called manually to build BVH tree for any sensitive set in case if its content was initialized not in a constructor, but element by element.
 
bool ToBuildBVH () const override
 Returns TRUE if BVH tree is in invalidated state.
 
void SetBuilder (const occ::handle< Select3D_BVHBuilder3d > &theBuilder)
 Sets the method (builder) used to construct BVH.
 
void MarkDirty ()
 Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH()
 
Select3D_BndBox3d BoundingBox () override
 Returns bounding box of the whole set. This method should be redefined in Select3D_SensitiveSet descendants.
 
gp_Pnt CenterOfGeometry () const override
 Returns center of the whole set. This method should be redefined in Select3D_SensitiveSet descendants.
 
void Clear () override
 Destroys cross-reference to avoid memory leak.
 
int GetLeafNodeSize () const
 Returns a number of nodes in 1 BVH leaf.
 
void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from Select3D_SensitiveEntity
const occ::handle< SelectMgr_EntityOwner > & OwnerId () const
 Returns pointer to 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.
 
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.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (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_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.
 
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 Member Functions

bool isValidRay (const SelectBasics_SelectingVolumeManager &theMgr) const
 Checks if picking ray can be used for detection.
 
- Protected Member Functions inherited from Select3D_SensitivePrimitiveArray
void computeBoundingBox ()
 Compute bounding box.
 
Select3D_BndBox3d applyTransformation ()
 Inner function for transformation application to bounding box of the triangulation.
 
const NCollection_Vec3< float > & getPosVec3 (const int theIndex) const
 Auxiliary getter.
 
const NCollection_Vec2< float > & getPosVec2 (const int theIndex) const
 Auxiliary getter.
 
bool overlapsElement (SelectBasics_PickResult &thePickResult, SelectBasics_SelectingVolumeManager &theMgr, int theElemIdx, bool theIsFullInside) override
 Checks whether the element with index theIdx overlaps the current selecting volume.
 
double distanceToCOG (SelectBasics_SelectingVolumeManager &theMgr) override
 Calculates distance from the 3d projection of used-picked screen point to center of the geometry.
 
bool elementIsInside (SelectBasics_SelectingVolumeManager &theMgr, int theElemIdx, bool theIsFullInside) override
 Checks whether the entity with index theIdx is inside the current selecting volume.
 
- Protected Member Functions inherited from Select3D_SensitiveSet
bool matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult, bool theToCheckAllInside)
 Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set.
 
bool processElements (SelectBasics_SelectingVolumeManager &theMgr, int theFirstElem, int theLastElem, bool theIsFullInside, bool theToCheckAllInside, SelectBasics_PickResult &thePickResult, int &theMatchesNb)
 Process elements overlapped by the selection volume.
 
- Protected Member Functions inherited from Select3D_SensitiveEntity
 Select3D_SensitiveEntity (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Select3D_SensitiveSet
static const occ::handle< Select3D_BVHBuilder3d > & DefaultBVHBuilder ()
 Return global instance to default BVH builder.
 
static void SetDefaultBVHBuilder (const occ::handle< Select3D_BVHBuilder3d > &theBuilder)
 Assign new BVH builder to be used by default for new sensitive sets (assigning is NOT thread-safe!).
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_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 Attributes inherited from Select3D_SensitiveSet
BvhPrimitiveSet myContent
 A link between sensitive entity and BVH_PrimitiveSet.
 
int myDetectedIdx
 Index of detected primitive in BVH sorted primitive array.
 
- Protected Attributes inherited from Select3D_SensitiveEntity
occ::handle< SelectMgr_EntityOwnermyOwnerId
 
occ::handle< Graphic3d_TransformPersmyTrsfPers
 
occ::handle< Graphic3d_FlippermyFlipper
 
int mySFactor
 

Detailed Description

Simple sensitive element for picking by point only.

Constructor & Destructor Documentation

◆ AIS_ViewCubeSensitive()

AIS_ViewCubeSensitive::AIS_ViewCubeSensitive ( const occ::handle< SelectMgr_EntityOwner > & theOwner,
const occ::handle< Graphic3d_ArrayOfTriangles > & theTris )

Constructor.

Member Function Documentation

◆ isValidRay()

bool AIS_ViewCubeSensitive::isValidRay ( const SelectBasics_SelectingVolumeManager & theMgr) const
protected

Checks if picking ray can be used for detection.

◆ Matches()

bool AIS_ViewCubeSensitive::Matches ( SelectBasics_SelectingVolumeManager & theMgr,
SelectBasics_PickResult & thePickResult )
overridevirtual

Checks whether element overlaps current selecting volume.

Implements Select3D_SensitiveEntity.


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