Public Types | Public Member Functions | Static Public Member Functions | List of all members
AccuDraw Struct Referenceabstract

#include <AccuDraw.h>

Public Types

enum  CompassMode { MODE_Polar = 0, MODE_Rectangular = 1 }
 
enum  RotationMode {
  ROTATION_Top = 1, ROTATION_Front = 2, ROTATION_Side = 3, ROTATION_View = 4,
  ROTATION_ACS = 5, ROTATION_Context = 6, ROTATION_Restore = 7
}
 
enum  LockedStates {
  NONE_LOCKED = 0, X_BM = (1), Y_BM = (1<<1), VEC_BM = (1<<2),
  DIST_BM = (1<<3), XY_BM = (X_BM | Y_BM), ANGLE_BM = (XY_BM | VEC_BM)
}
 

Public Member Functions

bool IsActive ()
 
void Activate ()
 Compass is active/displayed. More...
 
void Deactivate ()
 For tools to explicitly enable AccuDraw before dynamics start. More...
 
IndexedViewportP GetCompassViewport ()
 For tools that don't support AccuDraw or don't want it automatically enabled. More...
 
void GetRotation (RotMatrixR rMatrix)
 Current compass viewport. More...
 
void GetOrigin (DPoint3dR origin)
 Current compass orientation. More...
 
void GetDelta (DVec3dR delta)
 Current compass origin. More...
 
double GetDistance ()
 Current compass xyz delta. More...
 
double GetAngle ()
 Current compass polar distance. More...
 
LockedStates GetLocked ()
 Current compass polar angle. More...
 
bool GetFloatingOrigin ()
 Current compass locks bitmask. More...
 
CompassMode GetCompassMode ()
 Current compass floating origin setting. More...
 
RotationMode GetRotationMode ()
 Current compass mode. More...
 
BentleyStatus SetContext (AccuDrawFlags flags, DPoint3dCP origin=NULL, DVec3dCP orientation=NULL, DVec3dCP delta=NULL, double const *distance=NULL, double const *angle=NULL, TransformCP trans=NULL)
 Current compass rotation type. More...
 
AccudrawInfGetAccudrawInfo ()
 

Static Public Member Functions

static AccuDrawR GetInstance ()
 Get the current AccuDraw instance. More...
 

Member Enumeration Documentation

Enumerator
MODE_Polar 
MODE_Rectangular 
Enumerator
NONE_LOCKED 
X_BM 
Y_BM 
VEC_BM 
DIST_BM 
XY_BM 
ANGLE_BM 
Enumerator
ROTATION_Top 
ROTATION_Front 
ROTATION_Side 
ROTATION_View 
ROTATION_ACS 
ROTATION_Context 
ROTATION_Restore 

Member Function Documentation

void Activate ( )

Compass is active/displayed.

void Deactivate ( )

For tools to explicitly enable AccuDraw before dynamics start.

AccudrawInf* GetAccudrawInfo ( )
double GetAngle ( )

Current compass polar distance.

CompassMode GetCompassMode ( )

Current compass floating origin setting.

IndexedViewportP GetCompassViewport ( )

For tools that don't support AccuDraw or don't want it automatically enabled.

void GetDelta ( DVec3dR  delta)

Current compass origin.

double GetDistance ( )

Current compass xyz delta.

bool GetFloatingOrigin ( )

Current compass locks bitmask.

static AccuDrawR GetInstance ( )
static

Get the current AccuDraw instance.

LockedStates GetLocked ( )

Current compass polar angle.

void GetOrigin ( DPoint3dR  origin)

Current compass orientation.

void GetRotation ( RotMatrixR  rMatrix)

Current compass viewport.

RotationMode GetRotationMode ( )

Current compass mode.

bool IsActive ( )
BentleyStatus SetContext ( AccuDrawFlags  flags,
DPoint3dCP  origin = NULL,
DVec3dCP  orientation = NULL,
DVec3dCP  delta = NULL,
double const *  distance = NULL,
double const *  angle = NULL,
TransformCP  trans = NULL 
)

Current compass rotation type.

Allows tools to provide hints to accudraw for setting compass location, orientation, mode, etc.


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

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.