xsi_line.h

Go to the documentation of this file.

//*****************************************************************************
//*****************************************************************************

#if (_MSC_VER > 1000) || defined(SGI_COMPILER)
#pragma once
#endif

#ifndef __XSILINE_H__
#define __XSILINE_H__

#include "sicppsdk.h"
#include "xsi_status.h"
#include "xsi_vector3.h"
#include <math.h>

namespace XSI {

namespace MATH {

//*****************************************************************************
//*****************************************************************************
class SICPPSDKDECL CLine
{
public:
    SICPPSDK_INLINE CLine();

    SICPPSDK_INLINE CLine( const CVector3 &in_point, const CVector3 &in_tangent );

    SICPPSDK_INLINE CLine( const CLine &in_line );

    SICPPSDK_INLINE ~CLine();

    SICPPSDK_INLINE CLine & operator=( const CLine & in_line );

    SICPPSDK_INLINE bool operator ==(const CLine &in_line )const;

    SICPPSDK_INLINE bool operator !=(const CLine &in_line )const;

    SICPPSDK_INLINE bool EpsilonEquals(const CLine &in_line, double in_dEpsilon)const;

    SICPPSDK_INLINE bool Equals(const CLine &in_line)const;

    bool Parallel(const CLine &in_line)const;

    bool Collinear(const CLine &in_line)const;

    SICPPSDK_INLINE CVector3 Project(const CVector3 &in_point)const;

    SICPPSDK_INLINE CVector3 GetClosestPoint(const CLine &in_line)const;

    SICPPSDK_INLINE double GetDistance(const CVector3 &in_point)const;

    SICPPSDK_INLINE double GetDistance(const CLine &in_line)const;

    SICPPSDK_INLINE CVector3 GetPosition(double in_param)const;

    double GetParameter(const CVector3 &in_point)const;

    bool Intersect(const CLine &in_line, CVector3 &out_point)const;

    SICPPSDK_INLINE const CVector3 &GetOrigin()const;

    SICPPSDK_INLINE const CVector3 &GetTangent()const;

    SICPPSDK_INLINE CLine &SetOrigin(const CVector3 &in_point);

    SICPPSDK_INLINE CLine &SetTangent(const CVector3 &in_tangent);

    SICPPSDK_INLINE CLine &Set(const CVector3 &in_point, const CVector3 &in_tangent);

    SICPPSDK_INLINE CLine& operator *=(const CMatrix3& in_matrix3);

    SICPPSDK_INLINE CLine& operator *=(const CMatrix4& in_matrix4);

    SICPPSDK_INLINE CLine& operator *=(const CTransformation& in_transformation);

    SICPPSDK_INLINE CLine& MulByMatrix3InPlace(const CMatrix3& in_matrix3);

    SICPPSDK_INLINE CLine& MulByMatrix3(const CLine &in_line, const CMatrix3 &in_matrix3);

    SICPPSDK_INLINE CLine& MulByMatrix4InPlace(const CMatrix4& in_matrix4);

    SICPPSDK_INLINE CLine& MulByMatrix4(const CLine &in_line, const CMatrix4 &in_matrix4);

    SICPPSDK_INLINE CLine& MulByTransformationInPlace(const CTransformation &in_transformation);

    SICPPSDK_INLINE CLine& MulByTransformation(const CLine &in_line, const CTransformation &in_transformation);

private:
    CVector3    m_vOrigin;
    CVector3    m_vTangent;
};

//inline functions
SICPPSDK_INLINE CLine::CLine()
: m_vOrigin(0.0, 0.0, 0.0), m_vTangent(1.0, 0.0, 0.0)
{
}

SICPPSDK_INLINE CLine::CLine( const CLine& in_line )
: m_vOrigin(in_line.m_vOrigin), m_vTangent(in_line.m_vTangent)
{
}

SICPPSDK_INLINE CLine::CLine( const CVector3 &in_pt, const CVector3 &in_dir )
: m_vOrigin(in_pt), m_vTangent(in_dir)
{}

SICPPSDK_INLINE CLine::~CLine()
{}

SICPPSDK_INLINE CLine& CLine::operator=( const CLine & in_line )
{
    m_vOrigin = in_line.m_vOrigin;
    m_vTangent = in_line.m_vTangent;
    return *this;
}

SICPPSDK_INLINE const CVector3 &CLine::GetOrigin()const
{
    return m_vOrigin;
}

SICPPSDK_INLINE const CVector3 &CLine::GetTangent()const
{
    return m_vTangent;
}

SICPPSDK_INLINE bool CLine::EpsilonEquals(const CLine& in_line, double in_dEpsilon)const
{
    return (this == &in_line ? true :
            (m_vOrigin.EpsilonEquals(in_line.m_vOrigin, in_dEpsilon) &&
             m_vTangent.EpsilonEquals(in_line.m_vTangent, in_dEpsilon)));
}


SICPPSDK_INLINE bool CLine::Equals(const CLine& in_line)const
{
    return (this == &in_line ? true :
            (m_vOrigin.Equals(in_line.m_vOrigin) &&
             m_vTangent.Equals(in_line.m_vTangent)));
}

SICPPSDK_INLINE bool CLine::operator ==(const CLine & in_line )const
{
    return Equals(in_line);
}

SICPPSDK_INLINE bool CLine::operator !=(const CLine & in_line )const
{
    return !Equals(in_line);
}

SICPPSDK_INLINE CVector3 CLine::GetPosition(double in_param)const
{
    CVector3 l_Result;
    l_Result.ScaleAdd( in_param, m_vTangent, m_vOrigin );
    return l_Result;
}

SICPPSDK_INLINE CLine & CLine::SetOrigin(const CVector3 &in_point)
{
    m_vOrigin = in_point;
    return *this;
}

SICPPSDK_INLINE CLine &CLine::SetTangent(const CVector3 &in_tangent)
{
    m_vTangent = in_tangent;
    return *this;
}

SICPPSDK_INLINE CLine & CLine::Set(const CVector3 &in_point, const CVector3 &in_tangent)
{
    m_vOrigin = in_point;
    m_vTangent = in_tangent;
    return *this;
}

SICPPSDK_INLINE CVector3 CLine::Project(const CVector3 &in_point)const
{
    return GetPosition(GetParameter(in_point));
}

SICPPSDK_INLINE CVector3 CLine::GetClosestPoint(const CLine &in_line)const
{
    CVector3 l_Closest;
    Intersect( in_line, l_Closest );
    return l_Closest;
}

SICPPSDK_INLINE double CLine::GetDistance(const CVector3 &in_point)const
{
    return Project(in_point).SubInPlace(in_point).GetLength();
}

SICPPSDK_INLINE double CLine::GetDistance(const CLine &in_line)const
{
    CVector3 l_Tmp;
    return ( Intersect( in_line, l_Tmp ) ? 0.0 : GetDistance( in_line.m_vOrigin ) );
}

SICPPSDK_INLINE CLine& CLine::MulByMatrix3(const CLine& in_line, const CMatrix3& in_matrix3)
{
    CVector3 l_NewOrigin, l_NewTangent;
    l_NewOrigin.MulByMatrix3(in_line.m_vOrigin, in_matrix3);
    l_NewTangent.Add(in_line.m_vOrigin, in_line.m_vTangent);
    l_NewTangent.MulByMatrix3InPlace(in_matrix3);
    l_NewTangent.SubInPlace(l_NewOrigin);
    return Set(l_NewOrigin, l_NewTangent);
}

SICPPSDK_INLINE CLine& CLine::MulByMatrix4(const CLine& in_line, const CMatrix4& in_matrix4)
{
    CVector3 l_NewOrigin, l_NewTangent;
    l_NewOrigin.MulByMatrix4(in_line.m_vOrigin, in_matrix4);
    l_NewTangent.Add(in_line.m_vOrigin, in_line.m_vTangent);
    l_NewTangent.MulByMatrix4InPlace(in_matrix4);
    l_NewTangent.SubInPlace(l_NewOrigin);
    return Set(l_NewOrigin, l_NewTangent);
}

SICPPSDK_INLINE CLine& CLine::MulByTransformation(const CLine &in_line, const CTransformation &in_transformation)
{
    CVector3 l_NewOrigin, l_NewTangent;
    l_NewOrigin.MulByTransformation(in_line.m_vOrigin, in_transformation);
    l_NewTangent.Add(in_line.m_vOrigin, in_line.m_vTangent);
    l_NewTangent.MulByTransformationInPlace(in_transformation);
    l_NewTangent.SubInPlace(l_NewOrigin);
    return Set(l_NewOrigin, l_NewTangent);
}

SICPPSDK_INLINE CLine& CLine::MulByMatrix3InPlace(const CMatrix3& in_matrix3)
{
    return MulByMatrix3(*this, in_matrix3);
}

SICPPSDK_INLINE CLine& CLine::MulByMatrix4InPlace(const CMatrix4& in_matrix4)
{
    return MulByMatrix4(*this, in_matrix4);
}

SICPPSDK_INLINE CLine& CLine::MulByTransformationInPlace(const CTransformation& in_crTrans)
{
    return MulByTransformation(*this, in_crTrans);
}

SICPPSDK_INLINE CLine& CLine::operator *=(const CMatrix3& in_matrix3)
{
    return MulByMatrix3InPlace(in_matrix3);
}

SICPPSDK_INLINE CLine& CLine::operator *=(const CMatrix4& in_matrix4)
{
    return MulByMatrix4InPlace(in_matrix4);
}

SICPPSDK_INLINE CLine& CLine::operator *=(const CTransformation& in_transformation)
{
    return MulByTransformationInPlace(in_transformation);
}

};
};

#endif // __XSILINE_H__