Acts::ObjVisualization3D Class Reference

This helper produces output in the OBJ format. More...

#include <Acts/Visualization/ObjVisualization3D.hpp>

Inheritance diagram for Acts::ObjVisualization3D:

Collaboration diagram for Acts::ObjVisualization3D:

Public Types
using	LineType = std::pair<std::size_t, std::size_t>
	Type of a line.
using	ValueType = double
	Stored value type, should be double or float.
using	VertexType = Eigen::Matrix<ValueType, 3, 1>
	Type of a vertex based on the value type.
Public Types inherited from Acts::IVisualization3D
using	FaceType = std::vector<std::size_t>
	Type alias for face definition as vertex indices.

Public Member Functions
	ObjVisualization3D (unsigned int prec=4, double scale=1.)
	Constructor that allows to set scalor and precision.
void	clear () final
	Remove all contents of this helper.
void	face (const std::vector< Vector3 > &vtxs, Color color=s_defaultColor) final
	Draw a face that connects a list of vertices.
void	faces (const std::vector< Vector3 > &vtxs, const std::vector< FaceType > &faces, Color color=s_defaultColor) final
	Draw a faces that connects a list of vertices - expert only.
void	line (const Vector3 &a, const Vector3 &b, Color color=s_defaultColor) final
	Draw a line from a vertex to another.
void	object (const std::string &name) final
	Start a new object context with a name.
void	vertex (const Vector3 &vtx, Color color=s_defaultColor) final
	Draw a vertex at a given location and a color.
void	write (const std::filesystem::path &path) const final
	Write the content of the helper to an outstream.
void	write (std::ostream &os) const final
	Write the content of the helper to an outstream.
void	write (std::ostream &os, std::ostream &mos) const
	Write the object and the material file.
Public Member Functions inherited from Acts::IVisualization3D
virtual	~IVisualization3D ()=default

Additional Inherited Members
Static Public Attributes inherited from Acts::IVisualization3D
static constexpr Color	s_defaultColor = {120, 120, 120}
	Default color used for visualization when no color is specified.

Detailed Description

This helper produces output in the OBJ format.

Note that colors are not supported in this implementation.

Member Typedef Documentation

LineType

using Acts::ObjVisualization3D::LineType = std::pair<std::size_t, std::size_t>

Type of a line.

ValueType

using Acts::ObjVisualization3D::ValueType = double

Stored value type, should be double or float.

VertexType

using Acts::ObjVisualization3D::VertexType = Eigen::Matrix<ValueType, 3, 1>

Type of a vertex based on the value type.

Constructor & Destructor Documentation

ObjVisualization3D()

Acts::ObjVisualization3D::ObjVisualization3D ( unsigned int prec = 4, double scale = 1. )

explicit

Constructor that allows to set scalor and precision.

Parameters

prec	The output precision with std::setprecision
scale	An (optional) scaling for the writing out

Member Function Documentation

clear()

void Acts::ObjVisualization3D::clear ( )

finalvirtual

Remove all contents of this helper.

Implements Acts::IVisualization3D.

face()

void Acts::ObjVisualization3D::face ( const std::vector< Vector3 > & vtxs, Color color = s_defaultColor )

finalvirtual

Draw a face that connects a list of vertices.

Note

Depending on the helper implementation, out of plane vertices might be handled differently.

Parameters

vtxs	The vertices that make up the face
color	The color of the face

Implements Acts::IVisualization3D.

faces()

void Acts::ObjVisualization3D::faces ( const std::vector< Vector3 > & vtxs, const std::vector< FaceType > & faces, Color color = s_defaultColor )

finalvirtual

Draw a faces that connects a list of vertices - expert only.

Note

Depending on the helper implementation, out of plane vertices might be handled differently.

Parameters

vtxs	The vertices that make up the faceS
faces	The face presections (i.e. connecting vertices)
color	The color of the face

Implements Acts::IVisualization3D.

line()

void Acts::ObjVisualization3D::line ( const Vector3 & a, const Vector3 & b, Color color = s_defaultColor )

finalvirtual

Draw a line from a vertex to another.

Parameters

a	The start vertex
b	The end vertex
color	The color of the line

Implements Acts::IVisualization3D.

object()

void Acts::ObjVisualization3D::object ( const std::string & name )

finalvirtual

Start a new object context with a name.

Parameters

name	The name of the object

Implements Acts::IVisualization3D.

vertex()

void Acts::ObjVisualization3D::vertex ( const Vector3 & vtx, Color color = s_defaultColor )

finalvirtual

Draw a vertex at a given location and a color.

Parameters

vtx	The vertex position
color	The color

Implements Acts::IVisualization3D.

write() [1/3]

void Acts::ObjVisualization3D::write ( const std::filesystem::path & path ) const

finalvirtual

Write the content of the helper to an outstream.

Parameters

path	is the file system path for writing the file

Implements Acts::IVisualization3D.

write() [2/3]

void Acts::ObjVisualization3D::write ( std::ostream & os ) const

finalvirtual

Write the content of the helper to an outstream.

Parameters

os	The output stream for file

Implements Acts::IVisualization3D.

write() [3/3]

void Acts::ObjVisualization3D::write	(	std::ostream &	os,
		std::ostream &	mos ) const

Write the object and the material file.

Parameters

os	the output stream for the object
mos	the output stream for the auxiliary material file