Point.h

Go to the documentation of this file.

//! @file Point.h
//! @brief CPt class is the base class for different class of points (C3DPoint, CUVWPoint...)
//////////////////////////////////////////////////////////////////////
 
#if !defined(AFX_POINT_H__E9597161_87C0_11D3_A029_C00DB92E437A__INCLUDED_)
#define AFX_POINT_H__E9597161_87C0_11D3_A029_C00DB92E437A__INCLUDED_
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "4DPoint.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
//! @enum POINT_PROPERTIES
//! @brief Point flags used by any classes that inherit from CPt (C3DPoint, C3DVector...)
typedef enum  POINT_PROPERTIES XEnumType(unsigned int)
{
    POINT_NONE = 0x00,
    POINT_IS_SELECTED = 0x01,
    POINT_IS_INVALID = 0x02, //!< Make the point being deleted during clean operation
    POINT_IS_UNUSED = 0x04, //!< Make the point being ignored (invalid value)
    POINT_IS_SPECIFIED_NORMAL = 0x08, //!< Only for normals in SpecNormalChannel. This is a normal which value is computed using the face's normal connected to this point (cf. Autodesk 3ds Max > Edit Normals Modifier, which explains type of normals). If this flag is not set, then the normal is explicit (edited by the user). Mainly used during a 3ds Max Data Exchange.
 
    POINT_BELONG_TO_BORDER = 0x10, //!< The point belongs to an edge which a border edge (belonging to a single face)
    POINT_CONNECTED_TO_EDGE_NOT_AT_BORDER = 0x20, //!< The point belongs to an edge which belongs to several faces
    POINT_CONNECTED_TO_POINT_AT_BORDER = 0x40, //!< The point is connected to a point which is at the border (but the point itself is not at the border)
    POINT_IS_CONFUSED = 0x80, //!< The point is confused with one or several other points
    POINT_IS_3D_CORNER = 0x100, //!< The point is set on a 3D corner
    POINT_IS_2D_CORNER = 0x200, //!< The point is set on a 2D corner
 
    //! These flags reports breaks that might exists in channels
    //! They are both set in the channel points and in the geometry points
    //! ie. : POINT_SPECNORMAL_BREAK is set for a given point when two specified normals (from CSpecNormalChannel) that belong to
    //! a same point make an angle above a given threshold.
    POINT_UV_BREAK = 0x1000, //!< Used by points and uvwpoints
    POINT_VC_BREAK = 0x2000, //!< Used by points and vcpoints
    POINT_SPECNORMAL_BREAK = 0x4000, //!< A normal break exists belong an edge or belongs a point (when several normals belongs to a point) (this flag refer to CSpecNormalChannel normals)
    POINT_POINTNORMAL_BREAK = 0x8000, //!< Two or more faces make a normal angle above the smoothing threshold (this flag refer to CPointNormalChannel normals)
    POINT_UV_CORNER                 = 0x10000,
    POINT_SHARE_COPLANAR_FACES      = 0x20000, //!< Set if all faces connected to a point are coplanars (set through InitShareCoplanarFacesFlag).
    POINT_SHARE_SEVERAL_MATERIALS   = 0x40000, //!< Set if a point share several materials (set through InitShareSeveralMaterialsFlag)
    POINT_UV_SYMMETRY               = 0x80000,  //!< Used by uvwpoints and potentially by points (cf InitUVSymmetryFlag)
 
    POINT_USER_SELECTED     = 0x100000,  //!< Flag used for interacting with point list. This is a helper to keep POINT_IS_SELECTED flags is interaction canceled.
 
    POINT_USER_PROPERTIES1  = 0x01000000,
    POINT_USER_PROPERTIES2  = 0x02000000,
    POINT_USER_PROPERTIES3  = 0x04000000,
    POINT_USER_PROPERTIES4  = 0x08000000,
} POINT_PROPERTIES;
 
class C4DPoint;
 
//! @class CPt
//! @brief CPt base only contains some flags that are used by the derived class.
//! @details CPointList is a list of several CPt 
class DLL_3DFUNCTION CPt
{
protected:
    unsigned int flags;
 
public:
    CPt();
    virtual ~CPt(); // Destructor claimed by unreal
 
 
    // Flags informations
    unsigned int GetFlags() const;
    void SetFlags(unsigned int flags);
    void SetFlag(POINT_PROPERTIES flag, bool set);
    void SetFlags(unsigned int flags, bool set);
    bool IsFlagSet(POINT_PROPERTIES flag) const;
    bool IsOneFlagSet(int flag) const;
 
    virtual void To4DPoint(C4DPoint& pt) const = 0;
    virtual CPt& operator=(const C4DPoint&) = 0;
 
    virtual void Serialize(CXArchive& ar);
 
    virtual CPt& operator=(const CPt& refpoint);
 
#ifdef _DEBUG
    virtual void Dump() const;
    virtual bool IsKindOf(unsigned int classid) const;
    virtual unsigned int ClassID() const;
#endif
};
 
#if !defined(__WINDOWS__) || (_MSC_VER > 1600) // DelayLoad problem under VS2010
inline CPt::~CPt()
{
}
#endif
 
inline CPt::CPt()
{
    flags = POINT_NONE;
}
 
inline CPt& CPt::operator=(const CPt& refpoint)
{
    flags = refpoint.flags;
    return *this;
}
 
inline void CPt::SetFlag(POINT_PROPERTIES flag, bool set)
{
    if (set)
        flags |= flag;
    else
        flags &= ~flag;
}
 
inline void CPt::SetFlags(unsigned int newflags, bool set)
{
    if (set)
        flags |= newflags;
    else
        flags &= ~newflags;
}
 
inline bool CPt::IsFlagSet(POINT_PROPERTIES flag) const
{
    return ((flags & flag) == flag) ? true : false;
}
 
inline bool CPt::IsOneFlagSet(int flag) const
{
    return (flags & flag) ? true : false;
}
 
inline unsigned int CPt::GetFlags() const
{
    return flags;
}
 
inline void CPt::SetFlags(unsigned int refflags)
{
    this->flags = refflags;
}
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(AFX_POINT_H__E9597161_87C0_11D3_A029_C00DB92E437A__INCLUDED_)