CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Classes | Namespaces | Macros | Typedefs | Enumerations
DbGrip.h File Reference
#include "TD_PackPush.h"
#include "Ge/GePoint3d.h"
#include "SharedPtr.h"
#include "DbStubPtrArray.h"
#include "GsMarkerArray.h"
#include "TD_PackPop.h"

Go to the source code of this file.

Classes

class  OdDbGripData
 

Namespaces

namespace  OdDb
 
namespace  OdDbGripOperations
 

Macros

#define _ODDBGRIP_INCLUDED_   /*!DOM*/
 

Typedefs

typedef OdSharedPtr< OdDbGripDataOdDbGripDataPtr
 
typedef OdArray< OdDbGripDataPtrOdDbGripDataPtrArray
 
typedef OdArray< void *, OdMemoryAllocator< void * > > OdDbVoidPtrArray
 
typedef OdArray< OdDbDimData *, OdMemoryAllocator< OdDbDimData * > > OdDbDimDataPtrArray
 
typedef voidODHMENU
 
typedef OdArray< OdDbGripDataOdDbGripDataArray
 
typedef OdSmartPtr< OdDbCustomOsnapMode > OdDbCustomOsnapModePtr
 
typedef bool(* GripWorldDrawPtr) (OdDbGripData *pThis, OdGiWorldDraw *pWd, OdDbStub *entId, OdDbGripOperations::DrawType type, OdGePoint3d *imageGripPoint, double dGripSize)
 
typedef void(* GripViewportDrawPtr) (OdDbGripData *pThis, OdGiViewportDraw *pWd, OdDbStub *entId, OdDbGripOperations::DrawType type, OdGePoint3d *imageGripPoint, int gripSize)
 
typedef OdResult(* GripOperationPtr) (OdDbGripData *pThis, OdDbStub *entId, int iContextFlags)
 
typedef void(* GripOpStatusPtr) (OdDbGripData *pThis, OdDbStub *entId, OdDbGripOperations::GripStatus status)
 
typedef const OdChar *(* GripToolTipPtr) (OdDbGripData *pThis)
 
typedef void(* ContextMenuItemIndexPtr) (unsigned itemIndex)
 
typedef void(* GripDimensionPtr) (OdDbGripData *pThis, OdDbStub *entId, double dimScale, OdDbDimDataPtrArray &dimData)
 
typedef OdResult(* GripRtClkHandler) (OdDbGripDataArray &hotGrips, const OdDbStubPtrArray &ents, OdString &menuName, ODHMENU &menu, ContextMenuItemIndexPtr &cb)
 
typedef OdResult(* GripInputPointPtr) (OdDbGripData *pThis, OdDbStub *entId, bool &changedPoint, OdGePoint3d &newPoint, const OdGiViewport &viewContext, OdDbStub *viewportId, bool pointComputed, int history, const OdGePoint3d &lastPoint, const OdGePoint3d &rawPoint, const OdGePoint3d &grippedPoint, const OdGePoint3d &cartesianSnappedPoint, const OdGePoint3d &osnappedPoint, OdDb::OsnapMask osnapMask, const OdArray< OdDbCustomOsnapModePtr > &customOsnapModes, OdDb::OsnapMask osnapOverrides, const OdArray< OdDbCustomOsnapModePtr > &customOsnapOverrides, const OdDbStubPtrArray &pickedEntities, const OdArray< OdDbStubPtrArray > &nestedPickedEntities, const OdGsMarkerArray &gsSelectionMark, const OdDbStubPtrArray &keyPointEntities, const OdArray< OdDbStubPtrArray > &nestedKeyPointEntities, const OdGsMarkerArray &keyPointGsSelectionMark, const OdArray< OdSharedPtr< OdGeCurve3d > > &alignmentPaths, const OdGePoint3d &computedPoint)
 

Enumerations

enum  OdDb::DragStat { OdDb::kDragStart = 0 , OdDb::kDragEnd = 1 , OdDb::kDragAbort = 2 }
 
enum  OdDb::GripStat { OdDb::kGripsDone = 0 , OdDb::kGripsToBeDeleted = 1 , OdDb::kDimDataToBeDeleted = 2 }
 
enum  OdDbGripOperations::DrawType { OdDbGripOperations::kWarmGrip = 0 , OdDbGripOperations::kHoverGrip , OdDbGripOperations::kHotGrip , OdDbGripOperations::kDragImageGrip }
 
enum  OdDbGripOperations::GripStatus {
  OdDbGripOperations::kGripStart = 0 , OdDbGripOperations::kGripEnd , OdDbGripOperations::kGripAbort , OdDbGripOperations::kStretch ,
  OdDbGripOperations::kMove , OdDbGripOperations::kRotate , OdDbGripOperations::kScale , OdDbGripOperations::kMirror ,
  OdDbGripOperations::kDimFocusChanged , OdDbGripOperations::kPopUpMenu
}
 
enum  OdDbGripOperations::GripFlags {
  OdDbGripOperations::kSkipWhenShared = 0x001 , OdDbGripOperations::kDisableRubberBandLine = 0x002 , OdDbGripOperations::kDisableModeKeywords = 0x004 , OdDbGripOperations::kDrawAtDragImageGripPoint = 0x008 ,
  OdDbGripOperations::kTriggerGrip = 0x010 , OdDbGripOperations::kTurnOnForcedPick = 0x020 , OdDbGripOperations::kMapGripHotToRtClk = 0x040 , OdDbGripOperations::kGizmosEnabled = 0x080 ,
  OdDbGripOperations::kGripIsPerViewport = 0x100
}
 
enum  OdDbGripOperations::GripContextFlags { OdDbGripOperations::kSharedGrip = 0x01 , OdDbGripOperations::kMultiHotGrip = 0x02 }
 
enum  OdDbGripOperations::GetGripPointsFlags { OdDbGripOperations::kGripPointsOnly = 0x01 , OdDbGripOperations::kCyclableGripsOnly = 0x02 , OdDbGripOperations::kDynamicDimMode = 0x04 }
 
enum  OdDbGripOperations::MoveGripPointsFlags {
  OdDbGripOperations::kOsnapped = 0x01 , OdDbGripOperations::kPolar = 0x02 , OdDbGripOperations::kOtrack = 0x04 , OdDbGripOperations::kZdir = 0x08 ,
  OdDbGripOperations::kKeyboard = 0x10
}
 
enum  OdDb::OsnapMask {
  OdDb::kOsMaskEnd = 0x000001 , OdDb::kOsMaskMid = 0x000002 , OdDb::kOsMaskCen = 0x000004 , OdDb::kOsMaskNode = 0x000008 ,
  OdDb::kOsMaskQuad = 0x000010 , OdDb::kOsMaskInt = 0x000020 , OdDb::kOsMaskIns = 0x000040 , OdDb::kOsMaskPerp = 0x000080 ,
  OdDb::kOsMaskTan = 0x000100 , OdDb::kOsMaskNear = 0x000200 , OdDb::kOsMaskQuick = 0x000400 , OdDb::kOsMaskApint = 0x000800 ,
  OdDb::kOsMaskImmediate = 0x010000 , OdDb::kOsMaskAllowTan = 0x020000 , OdDb::kOsMaskDisablePerp = 0x040000 , OdDb::kOsMaskRelCartesian = 0x080000 ,
  OdDb::kOsMaskRelPolar = 0x100000 , OdDb::kOsMaskNoneOverride = 0x200000
}
 

Macro Definition Documentation

◆ _ODDBGRIP_INCLUDED_

#define _ODDBGRIP_INCLUDED_   /*!DOM*/

Definition at line 28 of file DbGrip.h.

Typedef Documentation

◆ ContextMenuItemIndexPtr

typedef void(* ContextMenuItemIndexPtr) (unsigned itemIndex)

This type represents the context menu item index.

Definition at line 338 of file DbGrip.h.

◆ GripDimensionPtr

typedef void(* GripDimensionPtr) (OdDbGripData *pThis, OdDbStub *entId, double dimScale, OdDbDimDataPtrArray &dimData)

This type represents functions that get the dynamic dimensions of a grip when it becomes hot or is hovered over.

Definition at line 344 of file DbGrip.h.

◆ GripInputPointPtr

typedef OdResult(* GripInputPointPtr) (OdDbGripData *pThis, OdDbStub *entId, bool &changedPoint, OdGePoint3d &newPoint, const OdGiViewport &viewContext, OdDbStub *viewportId, bool pointComputed, int history, const OdGePoint3d &lastPoint, const OdGePoint3d &rawPoint, const OdGePoint3d &grippedPoint, const OdGePoint3d &cartesianSnappedPoint, const OdGePoint3d &osnappedPoint, OdDb::OsnapMask osnapMask, const OdArray< OdDbCustomOsnapModePtr > &customOsnapModes, OdDb::OsnapMask osnapOverrides, const OdArray< OdDbCustomOsnapModePtr > &customOsnapOverrides, const OdDbStubPtrArray &pickedEntities, const OdArray< OdDbStubPtrArray > &nestedPickedEntities, const OdGsMarkerArray &gsSelectionMark, const OdDbStubPtrArray &keyPointEntities, const OdArray< OdDbStubPtrArray > &nestedKeyPointEntities, const OdGsMarkerArray &keyPointGsSelectionMark, const OdArray< OdSharedPtr< OdGeCurve3d > > &alignmentPaths, const OdGePoint3d &computedPoint)

This type represents functions that are called when on the certain step of the grip editing operation the input point is received. Used for custom entities.

Definition at line 363 of file DbGrip.h.

◆ GripOperationPtr

typedef OdResult(* GripOperationPtr) (OdDbGripData *pThis, OdDbStub *entId, int iContextFlags)

This type represents functions that are called when a grip becomes hot or is hovered over.

Definition at line 317 of file DbGrip.h.

◆ GripOpStatusPtr

typedef void(* GripOpStatusPtr) (OdDbGripData *pThis, OdDbStub *entId, OdDbGripOperations::GripStatus status)

This type represents functions that notify about the edit status of a grip.

Definition at line 325 of file DbGrip.h.

◆ GripRtClkHandler

typedef OdResult(* GripRtClkHandler) (OdDbGripDataArray &hotGrips, const OdDbStubPtrArray &ents, OdString &menuName, ODHMENU &menu, ContextMenuItemIndexPtr &cb)

This type represents functions that are called when a grip is right-clicked.

Definition at line 353 of file DbGrip.h.

◆ GripToolTipPtr

typedef const OdChar *(* GripToolTipPtr) (OdDbGripData *pThis)

This type represents functions that get the tooltip string of a grip.

Definition at line 333 of file DbGrip.h.

◆ GripViewportDrawPtr

typedef void(* GripViewportDrawPtr) (OdDbGripData *pThis, OdGiViewportDraw *pWd, OdDbStub *entId, OdDbGripOperations::DrawType type, OdGePoint3d *imageGripPoint, int gripSize)

This type represents functions that are called to draw viewport-specific grip's graphics.

Definition at line 305 of file DbGrip.h.

◆ GripWorldDrawPtr

typedef bool(* GripWorldDrawPtr) (OdDbGripData *pThis, OdGiWorldDraw *pWd, OdDbStub *entId, OdDbGripOperations::DrawType type, OdGePoint3d *imageGripPoint, double dGripSize)

This type represents functions that are called to draw non-viewport-specific grip's graphics.

Definition at line 293 of file DbGrip.h.

◆ OdDbCustomOsnapModePtr

typedef OdSmartPtr<OdDbCustomOsnapMode> OdDbCustomOsnapModePtr

This template class is a specialization of the OdSmartPtr class template for OdDbCustomOsnapMode smart pointers.

Definition at line 86 of file DbGrip.h.

◆ OdDbDimDataPtrArray

This template class is a specialization of the OdArray class template for OdDbDimData pointers and corresponding memory allocators.

Definition at line 63 of file DbGrip.h.

◆ OdDbGripDataArray

This template class is a specialization of the OdArray class template for OdDbGripData pointers.

Definition at line 80 of file DbGrip.h.

◆ OdDbGripDataPtr

This template class is a specialization of the OdSharedPtr class template for OdDbGripData shared pointers.

Definition at line 43 of file DbGrip.h.

◆ OdDbGripDataPtrArray

This template class is a specialization of the OdArray class template for OdDbGripData pointers.

Definition at line 49 of file DbGrip.h.

◆ OdDbVoidPtrArray

This template class is a specialization of the OdArray class template for void pointers and corresponding memory allocators.

Definition at line 55 of file DbGrip.h.

◆ ODHMENU

typedef void* ODHMENU

This type defines the right-click menu.

Definition at line 74 of file DbGrip.h.