OdDbGripData Class Reference

#include <DbGrip.h>

Public Member Functions
	ODRX_HEAP_OPERATORS ()
	OdDbGripData ()
	OdDbGripData (const OdDbGripData &)
	OdDbGripData (const OdGePoint3d &pt, void *AppData, GripOperationPtr hotGrip, GripOperationPtr hoverGrip, GripRtClkHandler RtClk, GripWorldDrawPtr wd, GripViewportDrawPtr vd, GripOpStatusPtr stat, GripToolTipPtr tt, GripDimensionPtr hoverDim, GripDimensionPtr hotGripDim, unsigned bitFlags, OdGePoint3d *altBasePt, GripInputPointPtr inputPointFunc)
	OdDbGripData (const OdGePoint3d &pt, void *AppData, OdRxClass *pAppDataClass, GripOperationPtr hotGrip, GripOperationPtr hoverGrip, GripRtClkHandler RtClk, GripWorldDrawPtr wd, GripViewportDrawPtr vd, GripOpStatusPtr stat, GripToolTipPtr tt, GripDimensionPtr hoverDim, GripDimensionPtr hotGripDim, unsigned bitFlags, OdGePoint3d *altBasePt, GripInputPointPtr inputPointFunc)
void	setAllData (const OdGePoint3d &pt, void *AppData, GripOperationPtr hotGrip, GripOperationPtr hoverGrip, GripRtClkHandler RtClk, GripWorldDrawPtr wd, GripViewportDrawPtr vd, GripOpStatusPtr stat, GripToolTipPtr tt, GripDimensionPtr hoverDim, GripDimensionPtr hotGripDim, unsigned bitFlags, OdGePoint3d *altBasePt, GripInputPointPtr inputPointFunc, OdRxClass *pAppDataClass)
OdDbGripData &	operator= (const OdDbGripData &)
const OdGePoint3d &	gripPoint () const
void	setGripPoint (const OdGePoint3d &pt)
void *	appData () const
void	setAppData (void *pAppData)
OdRxClass *	appDataOdRxClass () const
void	setAppDataOdRxClass (OdRxClass *pClass)
GripOperationPtr	hotGripFunc () const
void	setHotGripFunc (GripOperationPtr pf)
GripOperationPtr	hoverFunc () const
void	setHoverFunc (GripOperationPtr pf)
GripWorldDrawPtr	worldDraw () const
void	setWorldDraw (GripWorldDrawPtr pf)
GripViewportDrawPtr	viewportDraw () const
void	setViewportDraw (GripViewportDrawPtr pf)
GripOpStatusPtr	gripOpStatFunc () const
void	setGripOpStatFunc (GripOpStatusPtr pf)
GripToolTipPtr	toolTipFunc () const
void	setToolTipFunc (GripToolTipPtr pf)
OdGePoint3d *	alternateBasePoint () const
void	setAlternateBasePoint (OdGePoint3d *altBasePt)
unsigned	bitFlags () const
void	setBitFlags (unsigned flags)
bool	skipWhenShared () const
void	setSkipWhenShared (bool skip)
bool	isRubberBandLineDisabled () const
void	disableRubberBandLine (bool disable)
bool	areModeKeywordsDisabled () const
void	disableModeKeywords (bool disable)
bool	drawAtDragImageGripPoint () const
void	setDrawAtDragImageGripPoint (bool atDragPoint)
bool	triggerGrip () const
void	setTriggerGrip (bool trigger)
bool	forcedPickOn () const
void	setForcedPickOn (bool on)
bool	mapGripHotToRtClk () const
void	setMapGripHotToRtClk (bool on)
bool	gizmosEnabled () const
void	setGizmosEnabled (bool on)
bool	gripIsPerViewport () const
void	setGripIsPerViewport (bool on)
GripDimensionPtr	hoverDimensionFunc () const
void	setHoverDimensionFunc (GripDimensionPtr pf)
GripDimensionPtr	hotGripDimensionFunc () const
void	setHotGripDimensionFunc (GripDimensionPtr pf)
GripRtClkHandler	rtClk () const
void	setRtClk (GripRtClkHandler pf)
GripInputPointPtr	inputPointFunc () const
void	setInputPointFunc (GripInputPointPtr pf)

Detailed Description

This class passes parameters for the getGripPoints and moveGripPoints functions of OdDbEntity.

See also

TD_Db

<group OdDb_Classes>

Definition at line 390 of file DbGrip.h.

Constructor & Destructor Documentation

OdDbGripData() [1/4]

OdDbGripData::OdDbGripData ( )

inline

Default constructor. Creates a new object of the OdDbGripData class.

Definition at line 958 of file DbGrip.h.

OdDbGripData() [2/4]

OdDbGripData::OdDbGripData ( const OdDbGripData &  srcData )

inline

Copy constructor. Creates a clone of an existing object of the OdDbGripData class.

Parameters

OdGripData

[in] Object of the OdDbGripData class to be cloned.

Definition at line 976 of file DbGrip.h.

OdDbGripData() [3/4]

OdDbGripData::OdDbGripData ( const OdGePoint3d &  pt, void *  AppData, GripOperationPtr  hotGrip, GripOperationPtr  hoverGrip, GripRtClkHandler  RtClk, GripWorldDrawPtr  wd, GripViewportDrawPtr  vd, GripOpStatusPtr  stat, GripToolTipPtr  tt, GripDimensionPtr  hoverDim, GripDimensionPtr  hotGripDim, unsigned  bitFlags, OdGePoint3d *  altBasePt, GripInputPointPtr  inputPointFunc  )

inline

Constructor. Creates a new object of the OdDbGripData class and sets its data.

Parameters

pt	[in] Grip point.
AppData	[in] Application-specific data.
hotGrip	[in] Function to call when the grip becomes hot.
hoverGrip	[in] Function to call when the grip is hovered over.
RtClk	[in] Function to call when the grip is right-clicked.
wd	[in] Function to draw grip's graphics.
vd	[in] Function to draw viewport-specific grip's graphics.
stat	[in] Function that notifies about the edit status of the grip.
tt	[in] Function that gets the tooltip string of the grip.
hoverDim	[in] Function that gets the dynamic dimensions of the grip when it is hovered over.
hotGripDim	[in] Function that gets the dynamic dimensions of the grip when it becomes hot.
bitFlags	[in] Flags used to modify the grip's behaviour. Specified by the GripFlags enumeration.
altBasePt	[in] Base point of the grip operation.
inputPointFunc	[in] Function to call when on the certain step of the grip editing operation the input point is received. Used for custom entities.

Definition at line 996 of file DbGrip.h.

OdDbGripData() [4/4]

OdDbGripData::OdDbGripData ( const OdGePoint3d &  pt, void *  AppData, OdRxClass *  pAppDataClass, GripOperationPtr  hotGrip, GripOperationPtr  hoverGrip, GripRtClkHandler  RtClk, GripWorldDrawPtr  wd, GripViewportDrawPtr  vd, GripOpStatusPtr  stat, GripToolTipPtr  tt, GripDimensionPtr  hoverDim, GripDimensionPtr  hotGripDim, unsigned  bitFlags, OdGePoint3d *  altBasePt, GripInputPointPtr  inputPointFunc  )

inline

Constructor. Creates a new object of the OdDbGripData class and sets its data including the OdRxClass object associated with this class.

Parameters

pt	[in] Grip point.
AppData	[in] Application-specific data.
pAppDataClass	[in] OdRxClass object associated with this OdDbGripData object.
hotGrip	[in] Function to call when the grip becomes hot.
hoverGrip	[in] Function to call when the grip is hovered over.
RtClk	[in] Function to call when the grip is right-clicked.
wd	[in] Function to draw grip's graphics.
vd	[in] Function to draw viewport-specific grip's graphics.
stat	[in] Function that notifies about the edit status of the grip.
tt	[in] Function that gets the tooltip string of the grip.
hoverDim	[in] Function that gets the dynamic dimensions of the grip when it is hovered over.
hotGripDim	[in] Function that gets the dynamic dimensions of the grip when it becomes hot.
bitFlags	[in] Flags used to modify the grip's behaviour. Specified by the GripFlags enumeration.
altBasePt	[in] Base point of the grip operation.
inputPointFunc	[in] Function to call when on the certain step of the grip editing operation the input point is received. Used for custom entities.

Definition at line 1023 of file DbGrip.h.

Member Function Documentation

alternateBasePoint()

OdGePoint3d * OdDbGripData::alternateBasePoint ( ) const

inline

Returns the base point of the grip operation for this OdDbGripData object.

Definition at line 1190 of file DbGrip.h.

appData()

void * OdDbGripData::appData ( ) const

inline

Returns the application-specific data structure of this OdDbGripData object.

Definition at line 1110 of file DbGrip.h.

appDataOdRxClass()

OdRxClass * OdDbGripData::appDataOdRxClass ( ) const

inline

Returns the OdRxClass object associated with this OdDbGripData object.

Definition at line 1120 of file DbGrip.h.

areModeKeywordsDisabled()

bool OdDbGripData::areModeKeywordsDisabled ( ) const

inline

Indicates whether the kDisableModeKeywords flag is set.

Returns

True if the kDisableModeKeywords flag is set; false otherwise.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1236 of file DbGrip.h.

bitFlags()

unsigned OdDbGripData::bitFlags ( ) const

inline

Returns the flags that modify the behaviour of this OdDbGripData object.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1200 of file DbGrip.h.

disableModeKeywords()

void OdDbGripData::disableModeKeywords ( bool  disable )

inline

Sets or clears the kDisableModeKeywords flag.

Parameters

disable

[in] True to set the flag; false to clear the flag.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1241 of file DbGrip.h.

disableRubberBandLine()

void OdDbGripData::disableRubberBandLine ( bool  disable )

inline

Sets or clears the kDisableRubberBandLine flag.

Parameters

disable

[in] True to set the flag; false to clear the flag.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1228 of file DbGrip.h.

drawAtDragImageGripPoint()

bool OdDbGripData::drawAtDragImageGripPoint ( ) const

inline

Indicates whether the kDrawAtDragImageGripPoint flag is set.

Returns

True if the kDrawAtDragImageGripPoint flag is set; false otherwise.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1249 of file DbGrip.h.

forcedPickOn()

bool OdDbGripData::forcedPickOn ( ) const

inline

Indicates whether the kTurnOnForcedPick flag is set.

Returns

True if the kTurnOnForcedPick flag is set; false otherwise.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1275 of file DbGrip.h.

gizmosEnabled()

bool OdDbGripData::gizmosEnabled ( ) const

inline

Indicates whether the kGizmosEnabled flag is set.

Returns

True if the kGizmosEnabled flag is set; false otherwise.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1301 of file DbGrip.h.

gripIsPerViewport()

bool OdDbGripData::gripIsPerViewport ( ) const

inline

Indicates whether the kGripIsPerViewport flag is set.

Returns

True if the kGripIsPerViewport flag is set; false otherwise.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1314 of file DbGrip.h.

gripOpStatFunc()

GripOpStatusPtr OdDbGripData::gripOpStatFunc ( ) const

inline

Returns the pointer to the function that notifies about the edit status of the grip.

Definition at line 1170 of file DbGrip.h.

gripPoint()

const OdGePoint3d & OdDbGripData::gripPoint ( ) const

inline

Returns the grip point of this OdDbGripData object.

Definition at line 1100 of file DbGrip.h.

hotGripDimensionFunc()

GripDimensionPtr OdDbGripData::hotGripDimensionFunc ( ) const

inline

Returns the pointer to the function that gets the dynamic dimensions of the grip when it becomes hot.

Definition at line 1337 of file DbGrip.h.

hotGripFunc()

GripOperationPtr OdDbGripData::hotGripFunc ( ) const

inline

Returns the pointer to the function that is called when the grip becomes hot.

Definition at line 1130 of file DbGrip.h.

hoverDimensionFunc()

GripDimensionPtr OdDbGripData::hoverDimensionFunc ( ) const

inline

Returns the pointer to the function that gets the dynamic dimensions of the grip when it is hovered over.

Definition at line 1327 of file DbGrip.h.

hoverFunc()

GripOperationPtr OdDbGripData::hoverFunc ( ) const

inline

Returns the pointer to the function that is called when the grip is hovered over.

Definition at line 1140 of file DbGrip.h.

inputPointFunc()

GripInputPointPtr OdDbGripData::inputPointFunc ( ) const

inline

Returns the pointer to the function that is called when on the certain step of the grip editing operation the input point is received. Used for custom entities.

Definition at line 1357 of file DbGrip.h.

isRubberBandLineDisabled()

bool OdDbGripData::isRubberBandLineDisabled ( ) const

inline

Indicates whether the kDisableRubberBandLine flag is set.

Returns

True if the kDisableRubberBandLine flag is set; false otherwise.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1223 of file DbGrip.h.

mapGripHotToRtClk()

bool OdDbGripData::mapGripHotToRtClk ( ) const

inline

Indicates whether the kMapGripHotToRtClk flag is set.

Returns

True if the kMapGripHotToRtClk flag is set; false otherwise.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1288 of file DbGrip.h.

ODRX_HEAP_OPERATORS()

OdDbGripData::ODRX_HEAP_OPERATORS

(

)

operator=()

OdDbGripData & OdDbGripData::operator= ( const OdDbGripData &  rightSide )

inline

Comparison operator. Compares this OdDbGripData object with another OdDbGripData object.

Parameters

OdDbGripData

[in] Object of the OdDbGripData class to be compared with this object.

Returns

True if this object is equal to the compared object; false otherwise.

Definition at line 1050 of file DbGrip.h.

rtClk()

GripRtClkHandler OdDbGripData::rtClk ( ) const

inline

Returns the pointer to the function that is called when the grip is right-clicked.

Definition at line 1347 of file DbGrip.h.

setAllData()

void OdDbGripData::setAllData ( const OdGePoint3d &  pt, void *  AppData, GripOperationPtr  hotGrip, GripOperationPtr  hoverGrip, GripRtClkHandler  RtClk, GripWorldDrawPtr  wd, GripViewportDrawPtr  vd, GripOpStatusPtr  stat, GripToolTipPtr  tt, GripDimensionPtr  hoverDim, GripDimensionPtr  hotGripDim, unsigned  bitFlags, OdGePoint3d *  altBasePt, GripInputPointPtr  inputPointFunc, OdRxClass *  pAppDataClass  )

inline

Sets all data of this OdDbGripData object.

Parameters

pt	[in] Grip point.
AppData	[in] Application-specific data.
hotGrip	[in] Function to call when the grip becomes hot.
hoverGrip	[in] Function to call when the grip is hovered over.
RtClk	[in] Function to call when the grip is right-clicked.
wd	[in] Function to draw grip's graphics.
vd	[in] Function to draw viewport-specific grip's graphics.
stat	[in] Function that notifies about the edit status of the grip.
tt	[in] Function that gets the tooltip string of the grip.
hoverDim	[in] Function that gets the dynamic dimensions of the grip when it is hovered over.
hotGripDim	[in] Function that gets the dynamic dimensions of the grip when it becomes hot.
bitFlags	[in] Flags used to modify the grip's behaviour. Specified by the GripFlags enumeration.
altBasePt	[in] Base point of the grip operation.
inputPointFunc	[in] Function to call when on the certain step of the grip editing operation the input point is received. Used for custom entities.
pAppDataClass	[in] OdRxClass object associated with this OdDbGripData object.

Definition at line 1073 of file DbGrip.h.

setAlternateBasePoint()

void OdDbGripData::setAlternateBasePoint ( OdGePoint3d *  altBasePt )

inline

Sets the base point of the grip operation for this OdDbGripData object.

Parameters

altBasePt

[in] Base point of the grip operation.

Definition at line 1195 of file DbGrip.h.

setAppData()

void OdDbGripData::setAppData ( void *  pAppData )

inline

Sets the application-specific data structure for this OdDbGripData object.

Parameters

pAppData

[in] Pointer to the application-specific data structure.

Definition at line 1115 of file DbGrip.h.

setAppDataOdRxClass()

void OdDbGripData::setAppDataOdRxClass ( OdRxClass *  pClass )

inline

Associates an OdRxClass object with this OdDbGripData object.

Parameters

pClass

[in] Pointer to the OdRxClass object to associate this OdDbGripData object with.

Definition at line 1125 of file DbGrip.h.

setBitFlags()

void OdDbGripData::setBitFlags ( unsigned  flags )

inline

Sets the flags that modify the behaviour of this OdDbGripData object.

Parameters

flags

[in] Flags value.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1205 of file DbGrip.h.

setDrawAtDragImageGripPoint()

void OdDbGripData::setDrawAtDragImageGripPoint ( bool  atDragPoint )

inline

Sets or clears the kDrawAtDragImageGripPoint flag.

Parameters

atDragPoint

[in] True to set the flag; false to clear the flag.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1254 of file DbGrip.h.

setForcedPickOn()

void OdDbGripData::setForcedPickOn ( bool  on )

inline

Sets or clears the kTurnOnForcedPick flag.

Parameters

on	[in] True to set the flag; false to clear the flag.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1280 of file DbGrip.h.

setGizmosEnabled()

void OdDbGripData::setGizmosEnabled ( bool  on )

inline

Sets or clears the kGizmosEnabled flag.

Parameters

on	[in] True to set the flag; false to clear the flag.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1306 of file DbGrip.h.

setGripIsPerViewport()

void OdDbGripData::setGripIsPerViewport ( bool  on )

inline

Sets or clears the kGripIsPerViewport flag.

Parameters

on	[in] True to set the flag; false to clear the flag.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1319 of file DbGrip.h.

setGripOpStatFunc()

void OdDbGripData::setGripOpStatFunc ( GripOpStatusPtr  pf )

inline

Assigns the function for this OdDbGripData object that notifies about the edit status of the grip.

Parameters

pf	[in] Pointer to the function that notifies about the edit status of the grip.

Definition at line 1175 of file DbGrip.h.

setGripPoint()

void OdDbGripData::setGripPoint ( const OdGePoint3d &  pt )

inline

Sets a new grip point for this OdDbGripData object.

Parameters

pt	[in] New grip point.

Definition at line 1105 of file DbGrip.h.

setHotGripDimensionFunc()

void OdDbGripData::setHotGripDimensionFunc ( GripDimensionPtr  pf )

inline

Assigns the function for this OdDbGripData object that is called to get the dynamic dimensions of the grip when it becomes hot.

Parameters

pf	[in] Pointer to the function that gets the dynamic dimensions of the grip when it becomes hot.

Definition at line 1342 of file DbGrip.h.

setHotGripFunc()

void OdDbGripData::setHotGripFunc ( GripOperationPtr  pf )

inline

Assigns the function for this OdDbGripData object that is called when the grip becomes hot.

Parameters

pf	[in] Pointer to the function that is called when the grip becomes hot.

Definition at line 1135 of file DbGrip.h.

setHoverDimensionFunc()

void OdDbGripData::setHoverDimensionFunc ( GripDimensionPtr  pf )

inline

Assigns the function for this OdDbGripData object that is called to get the dynamic dimensions of the grip when it is hovered over.

Parameters

pf	[in] Pointer to the function that gets the dynamic dimensions of the grip when it is hovered over.

Definition at line 1332 of file DbGrip.h.

setHoverFunc()

void OdDbGripData::setHoverFunc ( GripOperationPtr  pf )

inline

Assigns the function for this OdDbGripData object that is called when the grip is hovered over.

Parameters

pf	[in] Pointer to the function that is called when the grip is hovered over.

Definition at line 1145 of file DbGrip.h.

setInputPointFunc()

void OdDbGripData::setInputPointFunc ( GripInputPointPtr  pf )

inline

Assigns the function for this OdDbGripData object that is called when the certain step of the grip editing operation the input point is received. Used for custom entities.

Parameters

pf	[in] Pointer to the function that is called when the certain step of the grip editing operation the input point is received.

Definition at line 1362 of file DbGrip.h.

setMapGripHotToRtClk()

void OdDbGripData::setMapGripHotToRtClk ( bool  on )

inline

Sets or clears the kMapGripHotToRtClk flag.

Parameters

on	[in] True to set the flag; false to clear the flag.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1293 of file DbGrip.h.

setRtClk()

void OdDbGripData::setRtClk ( GripRtClkHandler  pf )

inline

Assigns the function for this OdDbGripData object that is called when the grip is right-clicked.

Parameters

pf	[in] Pointer to the function that is called when the grip is right-clicked.

Definition at line 1352 of file DbGrip.h.

setSkipWhenShared()

void OdDbGripData::setSkipWhenShared ( bool  skip )

inline

Sets or clears the kSkipWhenShared flag.

Parameters

skip	[in] True to set the flag; false to clear the flag.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1215 of file DbGrip.h.

setToolTipFunc()

void OdDbGripData::setToolTipFunc ( GripToolTipPtr  pf )

inline

Assigns the function for this OdDbGripData object that gets the tooltip string of the grip.

Parameters

pf	[in] Pointer to the function that gets the tooltip string of the grip.

Definition at line 1185 of file DbGrip.h.

setTriggerGrip()

void OdDbGripData::setTriggerGrip ( bool  trigger )

inline

Sets or clears the kTriggerGrip flag.

Parameters

trigger

[in] True to set the flag; false to clear the flag.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1267 of file DbGrip.h.

setViewportDraw()

void OdDbGripData::setViewportDraw ( GripViewportDrawPtr  pf )

inline

Assigns the function for this OdDbGripData object that is called to draw viwport-specific grip's graphics.

Parameters

pf	[in] Pointer to the function that is called to draw viwport-specific grip's graphics.

Definition at line 1165 of file DbGrip.h.

setWorldDraw()

void OdDbGripData::setWorldDraw ( GripWorldDrawPtr  pf )

inline

Assigns the function for this OdDbGripData object that is called to draw non-viwport-specific grip's graphics.

Parameters

pf	[in] Pointer to the function that is called to draw non-viwport-specific grip's graphics.

Definition at line 1155 of file DbGrip.h.

skipWhenShared()

bool OdDbGripData::skipWhenShared ( ) const

inline

Indicates whether the kSkipWhenShared flag is set.

Returns

True if the kSkipWhenShared flag is set; false otherwise.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1210 of file DbGrip.h.

toolTipFunc()

GripToolTipPtr OdDbGripData::toolTipFunc ( ) const

inline

Returns the pointer to the function that gets the tooltip string of the grip.

Definition at line 1180 of file DbGrip.h.

triggerGrip()

bool OdDbGripData::triggerGrip ( ) const

inline

Indicates whether the kTriggerGrip flag is set.

Returns

True if the kTriggerGrip flag is set; false otherwise.

Remarks

Flags values are specified by the GripFlags enumeration.

Definition at line 1262 of file DbGrip.h.

viewportDraw()

GripViewportDrawPtr OdDbGripData::viewportDraw ( ) const

inline

Returns the pointer to the function that is called to draw viwport-specific grip's graphics.

Definition at line 1160 of file DbGrip.h.

worldDraw()

GripWorldDrawPtr OdDbGripData::worldDraw ( ) const

inline

Returns the pointer to the function that is called to draw non-viwport-specific grip's graphics.

Definition at line 1150 of file DbGrip.h.

---

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

• DbGrip.h