CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdDbGripOverrule Class Reference

#include <DbEntityOverrule.h>

Inheritance diagram for OdDbGripOverrule:
OdRxOverrule OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbGripOverrule)
 
 OdDbGripOverrule ()
 
virtual OdResult getGripPoints (const OdDbEntity *pSubject, OdGePoint3dArray &gripPoints)
 
virtual OdResult getGripPoints (const OdDbEntity *pSubject, OdDbGripDataPtrArray &gripsData, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags)
 
virtual OdResult moveGripPointsAt (OdDbEntity *pSubject, const OdIntArray &indices, const OdGeVector3d &offset)
 
virtual OdResult moveGripPointsAt (OdDbEntity *pSubject, const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags)
 
virtual OdResult getStretchPoints (const OdDbEntity *pSubject, OdGePoint3dArray &stretchPoints)
 
virtual OdResult moveStretchPointsAt (OdDbEntity *pSubject, const OdIntArray &indices, const OdGeVector3d &offset)
 
virtual void gripStatus (OdDbEntity *pSubject, const OdDb::GripStat status)
 
- Public Member Functions inherited from OdRxOverrule
 ODRX_DECLARE_MEMBERS (OdRxOverrule)
 
virtual ~OdRxOverrule ()
 
virtual bool isApplicable (const OdRxObject *pOverruledSubject) const =0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxOverrule
static OdResult addOverrule (OdRxClass *pClass, OdRxOverrule *pOverrule, bool bAddAtLast=false)
 
static OdResult removeOverrule (OdRxClass *pClass, OdRxOverrule *pOverrule)
 
static void setIsOverruling (bool bIsOverruling)
 
static bool isOverruling ()
 
static bool hasOverrule (const OdRxObject *pSubject, OdRxClass *pOverruleClass)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class overrules a subset of grip linked operations which an entity specifies. It is used as a base class for classes derived from OdDbEntity to change their behavior. Each default implementation calls the corresponding method of the target class.

Corresponding C++ library: TD_Db <group OdDb_Classes>

Definition at line 178 of file DbEntityOverrule.h.

Constructor & Destructor Documentation

◆ OdDbGripOverrule()

OdDbGripOverrule::OdDbGripOverrule ( )

Constructor creates an instance of this class.

Member Function Documentation

◆ getGripPoints() [1/2]

virtual OdResult OdDbGripOverrule::getGripPoints ( const OdDbEntity pSubject,
OdDbGripDataPtrArray gripsData,
const double  curViewUnitSize,
const int  gripSize,
const OdGeVector3d curViewDir,
const int  bitFlags 
)
virtual

Overrules OdDbEntity::subGetGripPoints() method and calls it in the default implementation. This method returns eOk if successful.

Parameters
pSubject[in] A raw pointer to an entity.
gripsData[in] An array of pointers to dynamically allocated grip data objects.
curViewUnitSize[in] A size of one drawing unit in the current viewport (in pixels).
gripSize[in] A size of current grip point (in pixels).
curViewDir[in] A vector that specifies the view direction in the current viewport.
bitFlags[in] Mask of one or more flags specified by the OdDbGripOperations::GetGripPointsFlags enumeration.

◆ getGripPoints() [2/2]

virtual OdResult OdDbGripOverrule::getGripPoints ( const OdDbEntity pSubject,
OdGePoint3dArray gripPoints 
)
virtual

Overrules OdDbEntity::subGetGripPoints() method and calls it in the default implementation. This method returns eOk if successful.

Parameters
pSubject[in] A raw pointer to an entity.
gripPoints[in/out] An existing array to which the grip points should be appended.

◆ getStretchPoints()

virtual OdResult OdDbGripOverrule::getStretchPoints ( const OdDbEntity pSubject,
OdGePoint3dArray stretchPoints 
)
virtual

Overrules OdDbEntity::subGetStretchPoints() method and calls it in the default implementation. This method returns eOk if successful.

Parameters
pSubject[in] A raw pointer to an entity.
stretchPoints[in/out] An existing array to which the stretch points should be appended.

◆ gripStatus()

virtual void OdDbGripOverrule::gripStatus ( OdDbEntity pSubject,
const OdDb::GripStat  status 
)
virtual

Overrules OdDbEntity::subGripStatus() method and calls it in the default implementation.

Parameters
pSubject[in] A raw pointer to an entity.
status[in] The status of the grip operation specified by the OdDbGripOperations::GripStatus enumeration.

◆ moveGripPointsAt() [1/2]

virtual OdResult OdDbGripOverrule::moveGripPointsAt ( OdDbEntity pSubject,
const OdDbVoidPtrArray grips,
const OdGeVector3d offset,
int  bitFlags 
)
virtual

Overrules OdDbEntity::subMoveGripPointsAt() method and calls it in the default implementation. This method returns eOk if successful.

Parameters
pSubject[in] A raw pointer to an entity.
grips[in] An array of pointers referring to each grip point to be moved.
offset[in] A vector that indicates the direction and magnitude which the grip points have been translated.
bitFlags[in] Mask of one or more flags specified by the OdDbGripOperations::GetGripPointsFlags enumeration.

◆ moveGripPointsAt() [2/2]

virtual OdResult OdDbGripOverrule::moveGripPointsAt ( OdDbEntity pSubject,
const OdIntArray indices,
const OdGeVector3d offset 
)
virtual

Overrules OdDbEntity::subMoveGripPointsAt() method and calls it in the default implementation. This method returns eOk if successful.

Parameters
pSubject[in] A raw pointer to an entity.
indices[in] An array containing the indices corresponding to grip points obtained from the getGripPoints() method that indicate which grip points are now "hot."
offset[in] A vector that indicates the direction and magnitude which the grip points have been translated.

◆ moveStretchPointsAt()

virtual OdResult OdDbGripOverrule::moveStretchPointsAt ( OdDbEntity pSubject,
const OdIntArray indices,
const OdGeVector3d offset 
)
virtual

Overrules OdDbEntity::subMoveStretchPointsAt() method and calls it in the default implementation. This method returns eOk if successful.

Parameters
pSubject[in] A raw pointer to an entity.
indices[in] An array containing the indices that indicate which stretch points are being translated.

◆ ODRX_DECLARE_MEMBERS()

OdDbGripOverrule::ODRX_DECLARE_MEMBERS ( OdDbGripOverrule  )

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