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

#include <DbEntityOverrule.h>

Inheritance diagram for OdDbSubentityOverrule:
OdRxOverrule OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbSubentityOverrule)
 
 OdDbSubentityOverrule ()
 
virtual OdResult deleteSubentPaths (OdDbEntity *pSubject, const OdDbFullSubentPathArray &paths)
 
virtual OdResult addSubentPaths (OdDbEntity *pSubject, const OdDbFullSubentPathArray &paths)
 
virtual OdResult transformSubentPathsBy (OdDbEntity *pSubject, const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform)
 
virtual OdResult getGripPointsAtSubentPath (const OdDbEntity *pSubject, const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags)
 
virtual OdResult moveGripPointsAtSubentPaths (OdDbEntity *pSubject, const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags)
 
virtual OdResult getSubentPathsAtGsMarker (const OdDbEntity *pSubject, OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &pickPoint, const OdGeMatrix3d &viewXform, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack=0)
 
virtual OdResult getGsMarkersAtSubentPath (const OdDbEntity *pSubject, const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers)
 
virtual OdDbEntityPtr subentPtr (const OdDbEntity *pSubject, const OdDbFullSubentPath &id)
 
virtual OdResult getCompoundObjectTransform (const OdDbEntity *pSubject, OdGeMatrix3d &xMat)
 
virtual OdResult getSubentPathGeomExtents (const OdDbEntity *pSubject, const OdDbFullSubentPath &path, OdGeExtents3d &extents)
 
virtual void subentGripStatus (OdDbEntity *pSubject, OdDb::GripStat status, const OdDbFullSubentPath &subentity)
 
virtual OdResult getSubentClassId (const OdDbEntity *pSubject, const OdDbFullSubentPath &path, void *clsId)
 
- 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 subentity 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 280 of file DbEntityOverrule.h.

Constructor & Destructor Documentation

◆ OdDbSubentityOverrule()

OdDbSubentityOverrule::OdDbSubentityOverrule ( )

Constructor creates an instance of this class.

Member Function Documentation

◆ addSubentPaths()

virtual OdResult OdDbSubentityOverrule::addSubentPaths ( OdDbEntity pSubject,
const OdDbFullSubentPathArray paths 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
paths[in] An array of full subentity path objects identifying the subentities to be added to the entity.

◆ deleteSubentPaths()

virtual OdResult OdDbSubentityOverrule::deleteSubentPaths ( OdDbEntity pSubject,
const OdDbFullSubentPathArray paths 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
paths[in] An array of full subentity path objects identifying the subentities to be deleted from the entity.

◆ getCompoundObjectTransform()

virtual OdResult OdDbSubentityOverrule::getCompoundObjectTransform ( const OdDbEntity pSubject,
OdGeMatrix3d xMat 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
xMat[out] A transformation matrix to be filled for nested objects.

◆ getGripPointsAtSubentPath()

virtual OdResult OdDbSubentityOverrule::getGripPointsAtSubentPath ( const OdDbEntity pSubject,
const OdDbFullSubentPath path,
OdDbGripDataPtrArray grips,
const double  curViewUnitSize,
const int  gripSize,
const OdGeVector3d curViewDir,
const OdUInt32  bitflags 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
path[in] A full subentity path object identifying the subentity.
grips[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.

◆ getGsMarkersAtSubentPath()

virtual OdResult OdDbSubentityOverrule::getGsMarkersAtSubentPath ( const OdDbEntity pSubject,
const OdDbFullSubentPath subPath,
OdGsMarkerArray gsMarkers 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
subPath[in] A full subentity path object identifying the subentity.
gsMarkers[out] An array with GSMarkers for the subentities.

◆ getSubentClassId()

virtual OdResult OdDbSubentityOverrule::getSubentClassId ( const OdDbEntity pSubject,
const OdDbFullSubentPath path,
void clsId 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
path[in] A full subentity path object identifying the subentity.
clsId[out] A pointer to the class description structure whose contents are set for the subentity.

◆ getSubentPathGeomExtents()

virtual OdResult OdDbSubentityOverrule::getSubentPathGeomExtents ( const OdDbEntity pSubject,
const OdDbFullSubentPath path,
OdGeExtents3d extents 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
path[in] A full subentity path object identifying the subentity.
extents[out] An extents object in which subentity extents should be saved.

◆ getSubentPathsAtGsMarker()

virtual OdResult OdDbSubentityOverrule::getSubentPathsAtGsMarker ( const OdDbEntity pSubject,
OdDb::SubentType  type,
OdGsMarker  gsMark,
const OdGePoint3d pickPoint,
const OdGeMatrix3d viewXform,
OdDbFullSubentPathArray subentPaths,
const OdDbObjectIdArray pEntAndInsertStack = 0 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
type[in] A subentity type specified by the OdDb::SubentType enumeration.
gsMark[in] GS marker representing a specific subentity.
pickPoint[in] WCS coordinates of the point picked during the selection of the entity.
viewXform[in] A transformation matrix to transform from WCS to DCS.
subentPaths[out] An array of full subentity path objects identifying the subentities generated from the GS marker.
pEntAndInsertStack[in] An array of object IDs that are the nested containers of the subentity.

◆ moveGripPointsAtSubentPaths()

virtual OdResult OdDbSubentityOverrule::moveGripPointsAtSubentPaths ( OdDbEntity pSubject,
const OdDbFullSubentPathArray paths,
const OdDbVoidPtrArray gripAppData,
const OdGeVector3d offset,
const OdUInt32  bitflags 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
paths[in] An array of full subentity path objects identifying the subentities to be moved.
gripAppData[in] An array of pointers referring to each grip point to be moved.
offset[in] A vector that indicates the direction and magnitude of the translation to be applied to the grips.
bitFlags[in] Mask of one or more flags specified by the OdDbGripOperations::GetGripPointsFlags enumeration.

◆ ODRX_DECLARE_MEMBERS()

OdDbSubentityOverrule::ODRX_DECLARE_MEMBERS ( OdDbSubentityOverrule  )

◆ subentGripStatus()

virtual void OdDbSubentityOverrule::subentGripStatus ( OdDbEntity pSubject,
OdDb::GripStat  status,
const OdDbFullSubentPath subentity 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
status[in] A status of the grip operation specified by the OdDb::GripStat enumeration.
path[in] A full subentity path object identifying the subentity whose grip status is to be changed.

◆ subentPtr()

virtual OdDbEntityPtr OdDbSubentityOverrule::subentPtr ( const OdDbEntity pSubject,
const OdDbFullSubentPath id 
)
virtual

Overrules the OdDbEntity::subentPtr() method and calls it in the default implementation. This method returns a smart pointer to the subentity if successful.

Parameters
pSubject[in] A raw pointer to an entity.
id[in] A full subentity path object identifying the subentity.

◆ transformSubentPathsBy()

virtual OdResult OdDbSubentityOverrule::transformSubentPathsBy ( OdDbEntity pSubject,
const OdDbFullSubentPathArray paths,
const OdGeMatrix3d xform 
)
virtual

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

Parameters
pSubject[in] A raw pointer to an entity.
paths[in] An array of full subentity path objects identifying the subentities to be transformed.
xform[in] A transformation matrix to be applied to each subentity.

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