FxOsnapPoint.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2023 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "DDKERNEL.h"
 
#include <DbEntity.h>
#include <Ge/GePoint3d.h>
 
#include "FxPragmaPush.h"
 
class CFxString;
class CFxTrackerContext;
 
class DDKERNEL_API CFxOsnapPoint
{
public:
    //Represents bits of variable OSMODE.
    enum OsnapMode
    {
        //DO NOT CHANGE VALUES!
        kOsModeStart      = -2,
        kOsModeUndefined  = -1,
        kOsModeNone       = 0,  // None
        kOsModeFirst      = 1,
        kOsModeEnd        = 1,  // End point
        kOsModeMid        = 2,  // Middle point
        kOsModeCen        = 3,  // Center
        kOsModeNode       = 4,  // Node
        kOsModeQuad       = 5,  // Quadrant
        kOsModeIntersec   = 6,  // Intersection
        kOsModeIns        = 7,  // Insertion point
        kOsModePerp       = 8,  // Perpendicular
        kOsModeTan        = 9,  // Tangent
        kOsModeNear       = 10, // Nearest
        kOsModeGeoCen     = 11, // Geometric Center
        kOsModeApint      = 12, // Apparent intersection
        kOsModeExt        = 13, // Extension
        kOsModePar        = 14, // Parallel
        kOsModeDisabled   = 15, // Disables all object snaps
        kOsModeCustom     = 16,
        kOsModeLast       = 16
    };
 
public:
    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 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);
};
 
#include "FxPragmaPop.h"