CFxOsnapPoint Class Reference

#include <FxOsnapPoint.h>

Public Types
enum	OsnapMode {   kOsModeStart = -2, kOsModeUndefined = -1, kOsModeNone = 0, kOsModeFirst = 1,   kOsModeEnd = 1, kOsModeMid = 2, kOsModeCen = 3, kOsModeNode = 4,   kOsModeQuad = 5, kOsModeIntersec = 6, kOsModeIns = 7, kOsModePerp = 8,   kOsModeTan = 9, kOsModeNear = 10, kOsModeGeoCen = 11, kOsModeApint = 12,   kOsModeExt = 13, kOsModePar = 14, kOsModeDisabled = 15, kOsModeCustom = 16,   kOsModeLast = 16 }

Public Member Functions
virtual	~CFxOsnapPoint ()
virtual const CFxOsnapPoint &	operator= (const CFxOsnapPoint &osnapPoint)
virtual void	Clear ()=0
virtual void	Set (const CFxOsnapPoint &osnapPoint)=0
virtual void	Set (CFxOsnapPoint::OsnapMode osnapMode, const OdGePoint3d &point, const OdDbFullSubentPath &first, const OdDbFullSubentPath &second)=0
virtual CFxOsnapPoint::OsnapMode	GetMode () const =0
virtual CFxString	GetModeName () const =0
virtual const OdGePoint3d &	GetPoint () const =0
virtual const OdDbFullSubentPath &	GetSubentPath (bool first=true) const =0
virtual bool	IsEqualTo (const CFxOsnapPoint &osnapPoint, double pointTol) const =0

Static Public Member Functions
static unsigned int	GetOsnapSize ()
static unsigned int	GetOsnapDistance ()
static ODCOLORREF	GetOsnapColor ()
static int	GetCenterSize ()
static ODCOLORREF	GetCenterColor (CFxTrackerContext *pContext)
static OdDb::OsnapMode	ConvertOsnapMode (const CFxOsnapPoint::OsnapMode &osnapMode)
static CFxOsnapPoint::OsnapMode	ConvertOsnapMode (const OdDb::OsnapMode &osnapMode)

Detailed Description

Definition at line 29 of file FxOsnapPoint.h.

Member Enumeration Documentation

OsnapMode

enum CFxOsnapPoint::OsnapMode

Enumerator
kOsModeStart
kOsModeUndefined
kOsModeNone
kOsModeFirst
kOsModeEnd
kOsModeMid
kOsModeCen
kOsModeNode
kOsModeQuad
kOsModeIntersec
kOsModeIns
kOsModePerp
kOsModeTan
kOsModeNear
kOsModeGeoCen
kOsModeApint
kOsModeExt
kOsModePar
kOsModeDisabled
kOsModeCustom
kOsModeLast

Definition at line 33 of file FxOsnapPoint.h.

Constructor & Destructor Documentation

~CFxOsnapPoint()

virtual CFxOsnapPoint::~CFxOsnapPoint ( )

virtual

Member Function Documentation

Clear()

virtual void CFxOsnapPoint::Clear ( )

pure virtual

Description: Clears this object to its blank/initial state.

ConvertOsnapMode() [1/2]

static OdDb::OsnapMode CFxOsnapPoint::ConvertOsnapMode ( const CFxOsnapPoint::OsnapMode &  osnapMode )

static

Description: Convert osnap mode. Arguments:

Parameters

osnapMode

The osnap mode.

Return Value: .

ConvertOsnapMode() [2/2]

static CFxOsnapPoint::OsnapMode CFxOsnapPoint::ConvertOsnapMode ( const OdDb::OsnapMode &  osnapMode )

static

Description: Convert osnap mode. Arguments:

Parameters

osnapMode

The osnap mode.

Return Value: .

GetCenterColor()

static ODCOLORREF CFxOsnapPoint::GetCenterColor ( CFxTrackerContext *  pContext )

static

Description: Gets a center color. Arguments:

Parameters

[in,out]

pContext

If non-null, the context.

Return Value: The center color.

GetCenterSize()

static int CFxOsnapPoint::GetCenterSize ( )

static

Description: Gets the center size.

Return Value: The center size.

GetMode()

virtual CFxOsnapPoint::OsnapMode CFxOsnapPoint::GetMode ( ) const

pure virtual

Description: Gets the mode. Return Value: The mode.

GetModeName()

virtual CFxString CFxOsnapPoint::GetModeName ( ) const

pure virtual

Description: Gets the mode name.

Return Value: The mode name.

GetOsnapColor()

static ODCOLORREF CFxOsnapPoint::GetOsnapColor ( )

static

Description: Gets the osnap color.

Return Value: The osnap color.

GetOsnapDistance()

static unsigned int CFxOsnapPoint::GetOsnapDistance ( )

static

Description: Gets the osnap distance.

Return Value: The osnap distance.

GetOsnapSize()

static unsigned int CFxOsnapPoint::GetOsnapSize ( )

static

Description: Gets the osnap size.

Return Value: The osnap size.

GetPoint()

virtual const OdGePoint3d& CFxOsnapPoint::GetPoint ( ) const

pure virtual

Description: Gets the point.

Return Value: The point.

GetSubentPath()

virtual const OdDbFullSubentPath& CFxOsnapPoint::GetSubentPath ( bool  first = true ) const

pure virtual

Description: Gets the subent path. Arguments:

Parameters

first

Set to 'false' if you need second entity for intersection osnap. Return Value: The subent path.

IsEqualTo()

virtual bool CFxOsnapPoint::IsEqualTo ( const CFxOsnapPoint &  osnapPoint, double  pointTol  ) const

pure virtual

Description: Query if 'osnapPoint' is equal to. Arguments:

Parameters

osnapPoint	The osnap point.
pointTol	The point tolerance.

Return Value: true if equal to, false if not.

operator=()

virtual const CFxOsnapPoint& CFxOsnapPoint::operator= ( const CFxOsnapPoint &  osnapPoint )

virtual

Set() [1/2]

virtual void CFxOsnapPoint::Set ( CFxOsnapPoint::OsnapMode  osnapMode, const OdGePoint3d &  point, const OdDbFullSubentPath &  first, const OdDbFullSubentPath &  second  )

pure virtual

Description: Sets osnap parameters. Arguments:

Parameters

osnapMode	The osnap mode.
point	The point.
first	The subent path.
second	Second path for intersection osnap.

Set() [2/2]

virtual void CFxOsnapPoint::Set ( const CFxOsnapPoint &  osnapPoint )

pure virtual

Description: Sets. Arguments:

Parameters

osnapPoint

The const CFxOsnapPoint& to set.

---

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

• FxOsnapPoint.h