eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::Easy3D::E3DAxisSystem Class Reference

Represent a 3D base axis system. More...

#include <eVision/Easy3D/E3DAxisSystem.h>

Inheritance diagram for eVision::Easy3D::E3DAxisSystem:
Collaboration diagram for eVision::Easy3D::E3DAxisSystem:

Public Member Functions

 E3DAxisSystem ()
 Constructs an E3DAxisSystem.
 E3DAxisSystem (const eVision::Easy3D::E3DPoint &Origin, const eVision::Easy3D::E3DPoint &axisX, const eVision::Easy3D::E3DPoint &axisY, const eVision::Easy3D::E3DPoint &axisZ)
 Constructs an E3DAxisSystem.
 E3DAxisSystem (const eVision::Easy3D::E3DAxisSystem &other)
 Constructs an E3DAxisSystem.
virtual ~E3DAxisSystem () throw ()
eVision::Easy3D::E3DAxisSystem & operator= (const eVision::Easy3D::E3DAxisSystem &other)
 Assignment operator.
bool operator== (const eVision::Easy3D::E3DAxisSystem &other) const
 equality operator
bool operator!= (const eVision::Easy3D::E3DAxisSystem &other) const
 inequality operator
eVision::Easy3D::E3DPoint GetOrigin () const
 Gets the origin.
eVision::Easy3D::E3DPoint GetAxisX () const
 Gets the X axis.
eVision::Easy3D::E3DPoint GetAxisY () const
 Gets the Y axis.
eVision::Easy3D::E3DPoint GetAxisZ () const
 Gets the Z axis.
float GetNormX () const
 Gets the norm of the X axis.
float GetNormY () const
 Gets the norm of the Y axis.
float GetNormZ () const
 Gets the norm of the Z axis.
bool IsRightHanded () const
 return true if this base axis system is Right Handed
bool IsOrthogonal () const
 return true if this base axis system is Orthogonal
bool IsNormal () const
 return true if this base axis system is Normed
void Load (const std::string &path)
 Load the E3DAxisSystem configuration. The given ESerializer must have been created for reading.
void Load (eVision::ESerializer *serializer)
 Load the E3DAxisSystem configuration. The given ESerializer must have been created for reading.
void Save (const std::string &path)
 Save the E3DAxisSystem configuration. The given ESerializer must have been created for writing.
void Save (eVision::ESerializer *serializer)
 Save the E3DAxisSystem configuration. The given ESerializer must have been created for writing.
 E3DAxisSystem (CppWrapperInternal::InternalConstructor)

Static Public Member Functions

static bool CheckIsOrthogonal (const eVision::Easy3D::E3DPoint &axisX, const eVision::Easy3D::E3DPoint &axisY, const eVision::Easy3D::E3DPoint &axisZ)
 check if the given axis system is Orthogonal
static bool CheckIsNormal (const eVision::Easy3D::E3DPoint &axisX, const eVision::Easy3D::E3DPoint &axisY, const eVision::Easy3D::E3DPoint &axisZ)
 check if the given axis system is Normed
static bool CheckIsRightHanded (const eVision::Easy3D::E3DPoint &axisX, const eVision::Easy3D::E3DPoint &axisY, const eVision::Easy3D::E3DPoint &axisZ)
 check if the given axis system is Right

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

Represent a 3D base axis system.

License(s): Easy3D

Constructor & Destructor Documentation

◆ E3DAxisSystem() [1/4]

eVision::Easy3D::E3DAxisSystem::E3DAxisSystem ( )

Constructs an E3DAxisSystem.

◆ E3DAxisSystem() [2/4]

eVision::Easy3D::E3DAxisSystem::E3DAxisSystem ( const eVision::Easy3D::E3DPoint & Origin,
const eVision::Easy3D::E3DPoint & axisX,
const eVision::Easy3D::E3DPoint & axisY,
const eVision::Easy3D::E3DPoint & axisZ )

Constructs an E3DAxisSystem.

Parameters
OriginThe origin of the axis system
axisXThe X axis
axisYThe Y axis
axisZThe Z axis

◆ E3DAxisSystem() [3/4]

eVision::Easy3D::E3DAxisSystem::E3DAxisSystem ( const eVision::Easy3D::E3DAxisSystem & other)

Constructs an E3DAxisSystem.

Parameters
otherReference to another E3DAxisSystem used for the initialization.

◆ ~E3DAxisSystem()

eVision::Easy3D::E3DAxisSystem::~E3DAxisSystem ( )
throw ( )
virtual

◆ E3DAxisSystem() [4/4]

eVision::Easy3D::E3DAxisSystem::E3DAxisSystem ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ CheckIsNormal()

bool eVision::Easy3D::E3DAxisSystem::CheckIsNormal ( const eVision::Easy3D::E3DPoint & axisX,
const eVision::Easy3D::E3DPoint & axisY,
const eVision::Easy3D::E3DPoint & axisZ )
static

check if the given axis system is Normed

Parameters
axisXE3DPoint representing the X-axis of the system.
axisYE3DPoint representing the Y-axis of the system.
axisZE3DPoint representing the Z-axis of the system.

◆ CheckIsOrthogonal()

bool eVision::Easy3D::E3DAxisSystem::CheckIsOrthogonal ( const eVision::Easy3D::E3DPoint & axisX,
const eVision::Easy3D::E3DPoint & axisY,
const eVision::Easy3D::E3DPoint & axisZ )
static

check if the given axis system is Orthogonal

Parameters
axisXE3DPoint representing the X-axis of the system.
axisYE3DPoint representing the Y-axis of the system.
axisZE3DPoint representing the Z-axis of the system.

◆ CheckIsRightHanded()

bool eVision::Easy3D::E3DAxisSystem::CheckIsRightHanded ( const eVision::Easy3D::E3DPoint & axisX,
const eVision::Easy3D::E3DPoint & axisY,
const eVision::Easy3D::E3DPoint & axisZ )
static

check if the given axis system is Right

Parameters
axisXE3DPoint representing the X-axis of the system.
axisYE3DPoint representing the Y-axis of the system.
axisZE3DPoint representing the Z-axis of the system.

◆ GetAxisX()

eVision::Easy3D::E3DPoint eVision::Easy3D::E3DAxisSystem::GetAxisX ( ) const

Gets the X axis.

◆ GetAxisY()

eVision::Easy3D::E3DPoint eVision::Easy3D::E3DAxisSystem::GetAxisY ( ) const

Gets the Y axis.

◆ GetAxisZ()

eVision::Easy3D::E3DPoint eVision::Easy3D::E3DAxisSystem::GetAxisZ ( ) const

Gets the Z axis.

◆ GetNormX()

float eVision::Easy3D::E3DAxisSystem::GetNormX ( ) const

Gets the norm of the X axis.

◆ GetNormY()

float eVision::Easy3D::E3DAxisSystem::GetNormY ( ) const

Gets the norm of the Y axis.

◆ GetNormZ()

float eVision::Easy3D::E3DAxisSystem::GetNormZ ( ) const

Gets the norm of the Z axis.

◆ GetOrigin()

eVision::Easy3D::E3DPoint eVision::Easy3D::E3DAxisSystem::GetOrigin ( ) const

Gets the origin.

◆ IsNormal()

bool eVision::Easy3D::E3DAxisSystem::IsNormal ( ) const

return true if this base axis system is Normed

◆ IsOrthogonal()

bool eVision::Easy3D::E3DAxisSystem::IsOrthogonal ( ) const

return true if this base axis system is Orthogonal

◆ IsRightHanded()

bool eVision::Easy3D::E3DAxisSystem::IsRightHanded ( ) const

return true if this base axis system is Right Handed

◆ Load() [1/2]

void eVision::Easy3D::E3DAxisSystem::Load ( const std::string & path)

Load the E3DAxisSystem configuration. The given ESerializer must have been created for reading.

Parameters
pathThe file path.

◆ Load() [2/2]

void eVision::Easy3D::E3DAxisSystem::Load ( eVision::ESerializer * serializer)

Load the E3DAxisSystem configuration. The given ESerializer must have been created for reading.

Parameters
serializerThe serializer.

◆ operator!=()

bool eVision::Easy3D::E3DAxisSystem::operator!= ( const eVision::Easy3D::E3DAxisSystem & other) const

inequality operator

Parameters
otherThe other E3DAxisSystem that we will compare this one to.

◆ operator=()

eVision::Easy3D::E3DAxisSystem & eVision::Easy3D::E3DAxisSystem::operator= ( const eVision::Easy3D::E3DAxisSystem & other)

Assignment operator.

Parameters
otherThe source E3DAxisSystem.

◆ operator==()

bool eVision::Easy3D::E3DAxisSystem::operator== ( const eVision::Easy3D::E3DAxisSystem & other) const

equality operator

Parameters
otherThe other E3DAxisSystem that we will compare this one to.

◆ Save() [1/2]

void eVision::Easy3D::E3DAxisSystem::Save ( const std::string & path)

Save the E3DAxisSystem configuration. The given ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Save() [2/2]

void eVision::Easy3D::E3DAxisSystem::Save ( eVision::ESerializer * serializer)

Save the E3DAxisSystem configuration. The given ESerializer must have been created for writing.

Parameters
serializerThe serializer.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::Easy3D::E3DAxisSystem::wrappedClass_