Represents the axis and the grid to display in the E3DViewer. More...

#include <eVision/Easy3D/E3DAxisDisplay.h>

Collaboration diagram for eVision::Easy3D::E3DAxisDisplay:

Public Member Functions
	E3DAxisDisplay ()
	Creates an E3DAxisDisplay object.
	E3DAxisDisplay (const eVision::Easy3D::E3DAxisDisplay &other)
	Creates an E3DAxisDisplay object.
virtual	~E3DAxisDisplay () throw ()
eVision::Easy3D::E3DAxisDisplay &	operator= (const eVision::Easy3D::E3DAxisDisplay &other)
	Assignment operator.
bool	operator== (const eVision::Easy3D::E3DAxisDisplay &other) const
	Comparison operator.
void	SetRenderAxis (bool state)
	Enables or disables the display of the axis.
bool	GetRenderAxis () const
	Enables or disables the display of the axis.
void	SetRenderGrid (bool state)
	Enables or disables the display of Grid.
bool	GetRenderGrid () const
	Enables or disables the display of Grid.
void	SetAxisOrigin (eVision::Easy3D::EAxisOriginMode mode)
	Set and Get the axis origin mode.
eVision::Easy3D::EAxisOriginMode	GetAxisOrigin () const
	Set and Get the axis origin mode.
void	SetAxisOriginUserDefined (const eVision::Easy3D::E3DPoint &origin)
	Set and Get the axis origin.
eVision::Easy3D::E3DPoint	GetAxisOriginUserDefined () const
	Set and Get the axis origin.
void	SetAxisSize (const eVision::Easy3D::E3DPoint &size)
	Sets/Gets the size of each axis.
eVision::Easy3D::E3DPoint	GetAxisSize () const
	Sets/Gets the size of each axis.
void	SetAxisXColor (eVision::ERGBColor color)
	Sets/Gets the color of the X axis.
eVision::ERGBColor	GetAxisXColor () const
	Sets/Gets the color of the X axis.
void	SetAxisYColor (eVision::ERGBColor color)
	Sets/Gets the color of the Y axis.
eVision::ERGBColor	GetAxisYColor () const
	Sets/Gets the color of the Y axis.
void	SetAxisZColor (eVision::ERGBColor color)
	Sets/Gets the color of the Z axis.
eVision::ERGBColor	GetAxisZColor () const
	Sets/Gets the color of the Z axis.
void	SetAxisGraduationColor (eVision::ERGBColor color)
	Sets/Gets the axis graduation color.
eVision::ERGBColor	GetAxisGraduationColor () const
	Sets/Gets the axis graduation color.
void	SetGridColor (eVision::ERGBColor color)
	Sets/Gets the grid color.
eVision::ERGBColor	GetGridColor () const
	Sets/Gets the grid color.
void	SetRenderGridStep (const eVision::Easy3D::E3DPoint &value)
	Sets/Gets the grid step of each axis.
eVision::Easy3D::E3DPoint	GetRenderGridStep () const
	Sets/Gets the grid step of each axis.
	E3DAxisDisplay (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Represents the axis and the grid to display in the E3DViewer.

License(s): Easy3D

Constructor & Destructor Documentation

◆ E3DAxisDisplay() [1/3]

eVision::Easy3D::E3DAxisDisplay::E3DAxisDisplay ( )

Creates an E3DAxisDisplay object.

◆ E3DAxisDisplay() [2/3]

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

Creates an E3DAxisDisplay object.

Parameters

other Reference to the E3DAxisDisplay used for the initialization.

◆ ~E3DAxisDisplay()

eVision::Easy3D::E3DAxisDisplay::~E3DAxisDisplay	(		)
throw	(	)

virtual

◆ E3DAxisDisplay() [3/3]

eVision::Easy3D::E3DAxisDisplay::E3DAxisDisplay ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetAxisGraduationColor()

eVision::ERGBColor eVision::Easy3D::E3DAxisDisplay::GetAxisGraduationColor ( ) const

Sets/Gets the axis graduation color.

The default color is white.

◆ GetAxisOrigin()

eVision::Easy3D::EAxisOriginMode eVision::Easy3D::E3DAxisDisplay::GetAxisOrigin ( ) const

Set and Get the axis origin mode.

The default mode is EAxisOriginMode::EAxisOriginMode_BoundingBoxOrigin.

◆ GetAxisOriginUserDefined()

eVision::Easy3D::E3DPoint eVision::Easy3D::E3DAxisDisplay::GetAxisOriginUserDefined ( ) const

Set and Get the axis origin.

This function also sets the axis origin mode to EAxisOriginMode::EAxisOriginMode_UserDefined.

◆ GetAxisSize()

eVision::Easy3D::E3DPoint eVision::Easy3D::E3DAxisDisplay::GetAxisSize ( ) const

Sets/Gets the size of each axis.

The unit is the same as the one from the EPointCloud. Default value is the size of EPointCloud rounded up.

◆ GetAxisXColor()

eVision::ERGBColor eVision::Easy3D::E3DAxisDisplay::GetAxisXColor ( ) const

Sets/Gets the color of the X axis.

The default color is red.

◆ GetAxisYColor()

eVision::ERGBColor eVision::Easy3D::E3DAxisDisplay::GetAxisYColor ( ) const

Sets/Gets the color of the Y axis.

The default color is green.

◆ GetAxisZColor()

eVision::ERGBColor eVision::Easy3D::E3DAxisDisplay::GetAxisZColor ( ) const

Sets/Gets the color of the Z axis.

The default color is blue.

◆ GetGridColor()

eVision::ERGBColor eVision::Easy3D::E3DAxisDisplay::GetGridColor ( ) const

Sets/Gets the grid color.

The default color is grey.

◆ GetRenderAxis()

bool eVision::Easy3D::E3DAxisDisplay::GetRenderAxis ( ) const

Enables or disables the display of the axis.

The default state is true.

◆ GetRenderGrid()

bool eVision::Easy3D::E3DAxisDisplay::GetRenderGrid ( ) const

Enables or disables the display of Grid.

Display Grid with true (true by default).

◆ GetRenderGridStep()

eVision::Easy3D::E3DPoint eVision::Easy3D::E3DAxisDisplay::GetRenderGridStep ( ) const

Sets/Gets the grid step of each axis.

The unit of the grid step value is the same as the one from the EPointCloud. If value is equal to 0, then the step is auto computed and if the value is smaller than 0, then there is no step on the axis. Default value is the size of the EPointCloud rounded up and divided by ten.

◆ operator=()

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

Assignment operator.

Parameters

other The E3DAxisDisplay object that should be copied.

◆ operator==()

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

Comparison operator.

Parameters

other The E3DAxisDisplay object to compare with.

◆ SetAxisGraduationColor()

void eVision::Easy3D::E3DAxisDisplay::SetAxisGraduationColor ( eVision::ERGBColor color )

Sets/Gets the axis graduation color.

Parameters

color The color.

The default color is white.

◆ SetAxisOrigin()

void eVision::Easy3D::E3DAxisDisplay::SetAxisOrigin ( eVision::Easy3D::EAxisOriginMode mode )

Set and Get the axis origin mode.

Parameters

mode	The axis origin mode from EAxisOriginMode.

The default mode is EAxisOriginMode::EAxisOriginMode_BoundingBoxOrigin.

◆ SetAxisOriginUserDefined()

void eVision::Easy3D::E3DAxisDisplay::SetAxisOriginUserDefined ( const eVision::Easy3D::E3DPoint & origin )

Set and Get the axis origin.

Parameters

origin The axis origin.

This function also sets the axis origin mode to EAxisOriginMode::EAxisOriginMode_UserDefined.

◆ SetAxisSize()

void eVision::Easy3D::E3DAxisDisplay::SetAxisSize ( const eVision::Easy3D::E3DPoint & size )

Sets/Gets the size of each axis.

The unit is the same as the one from the EPointCloud. Default value is the size of EPointCloud rounded up.

◆ SetAxisXColor()

void eVision::Easy3D::E3DAxisDisplay::SetAxisXColor ( eVision::ERGBColor color )

Sets/Gets the color of the X axis.

Parameters

color The color.

The default color is red.

◆ SetAxisYColor()

void eVision::Easy3D::E3DAxisDisplay::SetAxisYColor ( eVision::ERGBColor color )

Sets/Gets the color of the Y axis.

Parameters

color The color.

The default color is green.

◆ SetAxisZColor()

void eVision::Easy3D::E3DAxisDisplay::SetAxisZColor ( eVision::ERGBColor color )

Sets/Gets the color of the Z axis.

Parameters

color The color.

The default color is blue.

◆ SetGridColor()

void eVision::Easy3D::E3DAxisDisplay::SetGridColor ( eVision::ERGBColor color )

Sets/Gets the grid color.

Parameters

color The color.

The default color is grey.

◆ SetRenderAxis()

void eVision::Easy3D::E3DAxisDisplay::SetRenderAxis ( bool state )

Enables or disables the display of the axis.

Parameters

state Set to true to enable the display of the axis.

The default state is true.

◆ SetRenderGrid()

void eVision::Easy3D::E3DAxisDisplay::SetRenderGrid ( bool state )

Enables or disables the display of Grid.

Display Grid with true (true by default).

◆ SetRenderGridStep()

void eVision::Easy3D::E3DAxisDisplay::SetRenderGridStep ( const eVision::Easy3D::E3DPoint & value )

Sets/Gets the grid step of each axis.

Parameters

value The value of the step of each axis.

The unit of the grid step value is the same as the one from the EPointCloud. If value is equal to 0, then the step is auto computed and if the value is smaller than 0, then there is no step on the axis. Default value is the size of the EPointCloud rounded up and divided by ten.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::Easy3D::E3DAxisDisplay::wrappedClass_

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ E3DAxisDisplay() [1/3]

◆ E3DAxisDisplay() [2/3]

◆ ~E3DAxisDisplay()

◆ E3DAxisDisplay() [3/3]

Member Function Documentation

◆ GetAxisGraduationColor()

◆ GetAxisOrigin()

◆ GetAxisOriginUserDefined()

◆ GetAxisSize()

◆ GetAxisXColor()

◆ GetAxisYColor()

◆ GetAxisZColor()

◆ GetGridColor()

◆ GetRenderAxis()

◆ GetRenderGrid()

◆ GetRenderGridStep()

◆ operator=()

◆ operator==()

◆ SetAxisGraduationColor()

◆ SetAxisOrigin()

◆ SetAxisOriginUserDefined()

◆ SetAxisSize()

◆ SetAxisXColor()

◆ SetAxisYColor()

◆ SetAxisZColor()

◆ SetGridColor()

◆ SetRenderAxis()

◆ SetRenderGrid()

◆ SetRenderGridStep()

Member Data Documentation

◆ wrappedClass_