Open CASCADE Technology  7.6.0
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 Handle< SelectMgr_EntityOwner > &theOwner, const Handle< Graphic3d_ArrayOfTriangles > &theTris)
 Constructor. More...
 
virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
 Checks whether element overlaps current selecting volume. More...
 
- Public Member Functions inherited from Select3D_SensitivePrimitiveArray
 Select3D_SensitivePrimitiveArray (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 Constructs an empty sensitive object. More...
 
Standard_Integer PatchSizeMax () const
 Return patch size limit (1 by default). More...
 
void SetPatchSizeMax (const Standard_Integer thePatchSizeMax)
 Assign patch size limit. Should be set before initialization. More...
 
float PatchDistance () const
 Maximum allowed distance between consequential elements in patch (ShortRealLast() by default). Has no effect on indexed triangulation. More...
 
void SetPatchDistance (const float thePatchDistMax)
 Assign patch distance limit. Should be set before initialization. More...
 
bool InitTriangulation (const Handle< Graphic3d_Buffer > &theVerts, const Handle< Graphic3d_IndexBuffer > &theIndices, const TopLoc_Location &theInitLoc, const Standard_Integer theIndexLower, const Standard_Integer theIndexUpper, const bool theToEvalMinMax=true, const Standard_Integer 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!). More...
 
bool InitTriangulation (const Handle< Graphic3d_Buffer > &theVerts, const Handle< Graphic3d_IndexBuffer > &theIndices, const TopLoc_Location &theInitLoc, const bool theToEvalMinMax=true, const Standard_Integer theNbGroups=1)
 Initialize the sensitive object from triangualtion. More...
 
bool InitPoints (const Handle< Graphic3d_Buffer > &theVerts, const Handle< Graphic3d_IndexBuffer > &theIndices, const TopLoc_Location &theInitLoc, const Standard_Integer theIndexLower, const Standard_Integer theIndexUpper, const bool theToEvalMinMax=true, const Standard_Integer 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!). More...
 
bool InitPoints (const Handle< Graphic3d_Buffer > &theVerts, const Handle< Graphic3d_IndexBuffer > &theIndices, const TopLoc_Location &theInitLoc, const bool theToEvalMinMax=true, const Standard_Integer theNbGroups=1)
 Initialize the sensitive object from point set. More...
 
bool InitPoints (const Handle< Graphic3d_Buffer > &theVerts, const TopLoc_Location &theInitLoc, const bool theToEvalMinMax=true, const Standard_Integer theNbGroups=1)
 Initialize the sensitive object from point set. More...
 
void SetMinMax (double theMinX, double theMinY, double theMinZ, double theMaxX, double theMaxY, double theMaxZ)
 Assign new not transformed bounding box. More...
 
bool ToDetectElements () const
 Return flag to keep index of last topmost detected element, TRUE by default. More...
 
void SetDetectElements (bool theToDetect)
 Setup keeping of the index of last topmost detected element (axis picking). More...
 
bool ToDetectElementMap () const
 Return flag to keep index map of last detected elements, FALSE by default (rectangle selection). More...
 
void SetDetectElementMap (bool theToDetect)
 Setup keeping of the index map of last detected elements (rectangle selection). More...
 
bool ToDetectNodes () const
 Return flag to keep index of last topmost detected node, FALSE by default. More...
 
void SetDetectNodes (bool theToDetect)
 Setup keeping of the index of last topmost detected node (for axis picking). More...
 
bool ToDetectNodeMap () const
 Return flag to keep index map of last detected nodes, FALSE by default (rectangle selection). More...
 
void SetDetectNodeMap (bool theToDetect)
 Setup keeping of the index map of last detected nodes (rectangle selection). More...
 
bool ToDetectEdges () const
 Return flag to keep index of last topmost detected edge, FALSE by default. More...
 
void SetDetectEdges (bool theToDetect)
 Setup keeping of the index of last topmost detected edge (axis picking). More...
 
Standard_Integer LastDetectedElement () const
 Return last topmost detected element or -1 if undefined (axis picking). More...
 
const Handle< TColStd_HPackedMapOfInteger > & LastDetectedElementMap () const
 Return the index map of last detected elements (rectangle selection). More...
 
Standard_Integer LastDetectedNode () const
 Return last topmost detected node or -1 if undefined (axis picking). More...
 
const Handle< TColStd_HPackedMapOfInteger > & LastDetectedNodeMap () const
 Return the index map of last detected nodes (rectangle selection). More...
 
Standard_Integer LastDetectedEdgeNode1 () const
 Return the first node of last topmost detected edge or -1 if undefined (axis picking). More...
 
Standard_Integer LastDetectedEdgeNode2 () const
 Return the second node of last topmost detected edge or -1 if undefined (axis picking). More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. 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_Integer Size () const override
 Returns the length of array of triangles or edges. More...
 
virtual Standard_Integer NbSubElements () const override
 Returns the amount of nodes in triangulation. More...
 
virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const override
 Returns bounding box of triangle/edge with index theIdx. More...
 
virtual Standard_Real Center (const Standard_Integer theIdx, const Standard_Integer theAxis) const override
 Returns geometry center of triangle/edge with index theIdx in array along the given axis theAxis. More...
 
virtual void Swap (const Standard_Integer theIdx1, const Standard_Integer theIdx2) override
 Swaps items with indexes theIdx1 and theIdx2 in array. More...
 
virtual Select3D_BndBox3d BoundingBox () override
 Returns bounding box of the triangulation. If location transformation is set, it will be applied. More...
 
virtual gp_Pnt CenterOfGeometry () const override
 Returns center of triangulation. If location transformation is set, it will be applied. More...
 
virtual Standard_Boolean HasInitLocation () const override
 Returns true if the shape corresponding to the entity has init location. More...
 
virtual 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. More...
 
virtual void Set (const Handle< SelectMgr_EntityOwner > &theOwnerId) override
 Sets the owner for all entities in group. More...
 
virtual void BVH () override
 Builds BVH tree for sensitive set. More...
 
- Public Member Functions inherited from Select3D_SensitiveSet
 Select3D_SensitiveSet (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 Creates new empty sensitive set and its content. More...
 
virtual Standard_Boolean ToBuildBVH () const override
 Returns TRUE if BVH tree is in invalidated state. More...
 
void SetBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder)
 Sets the method (builder) used to construct BVH. More...
 
void MarkDirty ()
 Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH() More...
 
virtual void Clear () override
 Destroys cross-reference to avoid memory leak. More...
 
Standard_Integer GetLeafNodeSize () const
 Returns a number of nodes in 1 BVH leaf. More...
 
- Public Member Functions inherited from Select3D_SensitiveEntity
const Handle< SelectMgr_EntityOwner > & OwnerId () const
 Returns pointer to 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...
 
const Handle< Graphic3d_TransformPers > & TransformPersistence () const
 Return transformation persistence. More...
 
virtual void SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers)
 Set transformation persistence. 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 Member Functions

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

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 Select3D_SensitiveSet
static const Handle< Select3D_BVHBuilder3d > & DefaultBVHBuilder ()
 Return global instance to default BVH builder. More...
 
static void SetDefaultBVHBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder)
 Assign new BVH builder to be used by default for new sensitive sets (assigning is NOT thread-safe!). 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 Attributes inherited from Select3D_SensitiveSet
BvhPrimitiveSet myContent
 A link between sensitive entity and BVH_PrimitiveSet. More...
 
Standard_Integer myDetectedIdx
 Index of detected primitive in BVH sorted primitive array. More...
 
- Protected Attributes inherited from Select3D_SensitiveEntity
Handle< SelectMgr_EntityOwnermyOwnerId
 
Handle< Graphic3d_TransformPersmyTrsfPers
 
Standard_Integer mySFactor
 

Detailed Description

Simple sensitive element for picking by point only.

Constructor & Destructor Documentation

◆ AIS_ViewCubeSensitive()

AIS_ViewCubeSensitive::AIS_ViewCubeSensitive ( const Handle< SelectMgr_EntityOwner > &  theOwner,
const 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()

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

Checks whether element overlaps current selecting volume.

Reimplemented from Select3D_SensitivePrimitiveArray.


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