Contour.h

Go to the documentation of this file.

#pragma once
 
#include <ktm/global.h>
#include <math/Types.h>
#include <misc/gen/TVector.h>
 
namespace sf
{
 
enum EContourItemType
{
  citNONE,
  citARC,
  citPOINT,
};
 
enum EContourItemPoint
{
  cipNONE = -1,
  cipCENTER,
  cipSTART,
  cipSTOP,
  cipMID,
  cipLAST_ENTRY
};
 
struct _KTM_CLASS TContourItem
{
    // Default Constructor.
    TContourItem();
    // Copy Constructor.
    TContourItem(const TContourItem& cd)
    {
      Assign(cd);
    }
    // Arc constructor using angles in radials.
    TContourItem(const Vector2D& center, double radius, double start, double stop);
    // Arc constructor using three vectors and a radius.
    TContourItem(const Vector2D& center, double radius, const Vector2D& start, const Vector2D& stop);
    // Arc constructor using two vectors and a radius.
    TContourItem(double radius, const Vector2D& start, const Vector2D& stop);
    // Arc center 2 point constructor.
    TContourItem(const Vector2D& center, const Vector2D& start, const Vector2D& stop);
    // Arc 3P constructor.
    TContourItem(const Vector2D& p1, const Vector2D& p2, const Vector2D& p3, bool);
    // Adds a line of zero length. Start and stop are the same.
    TContourItem(const Vector2D& center);
    // Assignment operator.
    TContourItem& operator=(const TContourItem& cd);
    // Arc assignment.
    TContourItem& Assign(const TContourItem& cd);
    // Arc assignment using radials.
    TContourItem& Assign(const Vector2D& center, double radius, double start, double stop);
    // Arc assignment.
    TContourItem& Assign(const Vector2D& center, double radius, const Vector2D& start, const Vector2D& stop);
    // Arc assignment.
    TContourItem& Assign(double radius, const Vector2D& start, const Vector2D& stop);
    // Arc center 2 point assignment.
    TContourItem& Assign(const Vector2D& center, const Vector2D& start, const Vector2D& stop);
    // Arc 3P assignment.
    TContourItem& Assign(const Vector2D& p1, const Vector2D& p2, const Vector2D& p3, bool);
    // Assign Stop and Start value determined by type of content.
    // Does not change the radius.
    void SetStart(const Vector2D& v);
    void SetStop(const Vector2D& v);
    // Sets the center of the arc.
    void SetCenter(const Vector2D& v);
    // Sets the Mid vector of the contour item.
    void SetMid(const Vector2D& v);
    // Sets the radius of the arc.
    // When offset_center is true the center is changed to accommodate the radius.
    void SetRadius(double radius, bool offset_center);
    // Point assignment arc with radius zero.
    TContourItem& Assign(Vector2D center);
    // Resets the structure
    void Clear();
    // Resets the structure and sets the tag.
    void Clear(int tag);
    // Tells if the angle from start to stop is used clockwise.
    bool IsClockWise() const;
    // Returns the length of the arc described between start and stop angles.
    double GetArcLength() const;
    // Returns the angle of rotation from the start angle.
    // Positive values are counter clock wise negative are clock wise.
    double GetRotationAngle() const;
    // Returns true if the angle passed is part of the arc.
    bool IsAngle(double angle) const;
    // Returns the mid point on the arc.
    Vector2D GetMid() const;
    // Returns the smallest rectangle to contains this item.
    Rectangle2D GetExtend() const;
    // Makes of an array of center start and stop values.
    // All values of EContourItemPoint apply here.
    Vector2D GetPoint(int i) const;
    // Sets a point value.
    // All values of EContourItemPoint apply here.
    void SetPoint(int i, Vector2D v);
    // Returns the of the point when using the GetPoint function.
    static const char* GetPointName(int i);
    // Determines the type of data.
    EContourItemType Type;
    // The center point of the arc.
    Vector2D Center;
    // Start point.
    Vector2D Start;
    // End point.
    Vector2D Stop;
    // Radius of an arc in radials.
    double Radius;
    // Start angle of an arc in radials.
    double StartAngle;
    // Stop angle of an arc in radials.
    double StopAngle;
    // Field used for selection in a contour or other stuf. Is zero by default.
    int Tag;
};
 
inline TContourItem::TContourItem()
{
  Clear();
}
 
inline TContourItem::TContourItem(const Vector2D& center, double radius, double start, double stop)
{
  Tag = 0;
  Assign(center, radius, start, stop);
}
 
inline TContourItem::TContourItem(const Vector2D& center, double radius, const Vector2D& start, const Vector2D& stop)
{
  Tag = 0;
  Assign(center, radius, start, stop);
}
 
inline TContourItem::TContourItem(double radius, const Vector2D& start, const Vector2D& stop)
{
  Tag = 0;
  Assign(radius, start, stop);
}
 
inline TContourItem::TContourItem(const Vector2D& center, const Vector2D& start, const Vector2D& stop)
{
  Tag = 0;
  Assign(center, start, stop);
}
 
inline TContourItem::TContourItem(const Vector2D& p1, const Vector2D& p2, const Vector2D& p3, bool dum)
{
  Tag = 0;
  Assign(p1, p2, p3, dum);
}
 
inline TContourItem::TContourItem(const Vector2D& center)
{
  Tag = 0;
  Assign(center);
}
 
inline TContourItem& TContourItem::Assign(const TContourItem& cd)
{
  memcpy(this, &cd, sizeof(*this));
  return *this;
}
 
inline void TContourItem::Clear()
{
  memset(this, 0, sizeof(*this));
}
 
inline void TContourItem::Clear(int tag)
{
  memset(this, 0, sizeof(*this));
  Tag = tag;
}
 
inline TContourItem& TContourItem::operator=(const TContourItem& cd)
{
  return Assign(cd);
}
 
struct _KTM_CLASS TContourInfo
{
    // Default constructor.
    TContourInfo()
    {
      Clear();
    }
    // Puts all data members in their initial state.
    void Clear();
    // Returns true when the index is less then zero.
    bool IsEmpty();
    // Return distance value from start on the contour.
    double Distance;
    // Returns length value.
    double Length;
    // Return angle value at of the contour at the designated point.
    double Angle;
    // Point on the contour.
    Vector2D Point;
    // Contour segment index. Is less then zero when data is invalid.
    int Index;
};
 
//
inline void TContourInfo::Clear()
{
  Distance = 0.0;
  Length = 0.0;
  Angle = 0.0;
  Point.assign(0.0, 0.0);
  Index = -1;
}
 
//
inline bool TContourInfo::IsEmpty()
{
  // When the index is smaller than zero the instance contains no valid data.
  return Index <= 0;
}
 
class _KTM_CLASS TContour : public TVector<TContourItem>
{
  public:
    // Calculate second point for instance at 'index'.
    bool Connect(unsigned index, int mode);
    // Returns information on the point at a distance from the contours start.
    // Passed negative value is converted to a positive one.
    // Angle returned is the normal on the surface.
    bool GetInfo(double distance, TContourInfo& info) const;
    // Returns total length of contour.
    double GetLength() const;
    // Returns the length of a range of items.
    // Notice that add indexes are the line segments between the arcs.
    double GetLength(unsigned from, unsigned to) const;
    // Gets intersection information of vector line specified by passed
    // contour info. Returns true when an intersection was found on the contour.
    // The fields in the 'intersect' structure holds all information about
    // the intersection.
    //   Angle = angle at intersection from normal.
    //   Point = point of intersection.
    //   Index = index of intersected segment.
    //   Distance = distance from start on the contour.
    //   Length = Distance between the info points and found intersection point.
    bool GetIntersection(
      const TContourInfo& info,// Input information
      TContourInfo& intersect// Output intersection information.
    ) const;
    // Returns the smallest rectangle to contains all items.
    Rectangle2D GetExtend() const;
};
 
bool _KTM_FUNC GetSurfaceMatrix(
  const Vector2D& surf_point,// Point on the contour.
  double surf_angle,// Angle of the point on the contour.
  double rotangle,// Angle of rotation.
  Matrix44& surface// Returned matrix.
);
 
bool _KTM_FUNC GetSurfaceMatrix(
  const Vector2D& surf_point,// Point on the contour.
  double surf_angle,// Angle of the point on the contour.
  double rotangle,// Angle of rotation.
  double anglexz,// Local angle on the surface in the XZ-plane.
  double angleyz,// Local angle on the surface in the YZ-plane.
  double anglexy,// Local angle on the surface in the XY-plane.
  Matrix44& surface// Returned matrix.
);
 
}// namespace sf