The base class of renderable 3D models. More...

#include <easy3d/core/model.h>

Inheritance diagram for Model:

Public Member Functions
	Model (const std::string &name="unknown")
	Default constructor. The parameter `name` is optional, but it is useful for handling multiple models with the same viewer.

void	set_name (const std::string &n)
	Sets/Changes the name of a model. Assigning a name to a model is optional, but it is useful for handling multiple models with the same viewer.

const std::string &	name () const
	The name of a model.

const Box3 &	bounding_box (bool recompute=false) const
	The bounding box of the model.

void	invalidate_bounding_box ()
	Invalidates the bounding box of the model. So when bounding_box() is called, the bounding box will be re-computed. This function is typically called when the geometry of a model is changed.

virtual std::vector< vec3 > &	points ()=0
	The vertices of the model.

virtual const std::vector< vec3 > &	points () const =0
	The vertices of the model.

bool	empty () const
	Tests if the model is empty.

virtual void	property_stats (std::ostream &output) const
	Prints the names of all properties to an output stream (e.g., std::cout).

void	set_renderer (std::shared_ptr< Renderer > r)
	Sets the renderer of this model.

Renderer *	renderer ()
	Gets the renderer of this model.

const Renderer *	renderer () const
	Gets the constant renderer of this model.

void	set_manipulator (std::shared_ptr< Manipulator > manip)
	Attaches a manipulator to this model.

Manipulator *	manipulator ()
	Gets the manipulator attached to this model.

const Manipulator *	manipulator () const
	Gets the manipulator attached to this model.

Detailed Description

The base class of renderable 3D models.

A model can represent a SurfaceMesh, a PointCloud, or a Graph. A model can have multiple drawables, e.g., faces, vertices, edges.

Examples: Tutorial_203_Viewer_wxWidgets/main.cpp, Tutorial_301_Drawables/main.cpp, Tutorial_401_ModelPicker/main.cpp, Tutorial_402_FacePicker/main.cpp, Tutorial_405_ObjectManipulation/main.cpp, Tutorial_701_Cloud_NormalEstimation/main.cpp, Tutorial_702_Cloud_SurfaceReconstruction/main.cpp, and Tutorial_703_Cloud_PlaneExtraction/main.cpp.

Member Function Documentation

◆ bounding_box()

const Box3 & bounding_box ( bool recompute = false ) const

The bounding box of the model.

Parameters

recompute If true, or if the bounding box is not known, it computes and returns the bounding box of the model. Otherwise, it returns the known bounding box.

Note: Manipulation transformation is not handled.

See also: invalidate_bounding_box().

◆ points() [1/2]

virtual const std::vector< vec3 > & points ( ) const

pure virtual

The vertices of the model.

Implemented in Graph, PointCloud, PolyMesh, and SurfaceMesh.

◆ points() [2/2]

virtual std::vector< vec3 > & points ( )

pure virtual

The vertices of the model.

Implemented in Graph, PointCloud, PolyMesh, and SurfaceMesh.

◆ property_stats()

virtual void property_stats ( std::ostream & output ) const

inlinevirtual

Prints the names of all properties to an output stream (e.g., std::cout).

Reimplemented in Graph, PointCloud, PolyMesh, and SurfaceMesh.

Examples: Tutorial_203_Viewer_wxWidgets/main.cpp.

◆ set_manipulator()

void set_manipulator ( std::shared_ptr< Manipulator > manip )

inline

Attaches a manipulator to this model.

Note: Memory management of the manipulator is the user's responsibility.

◆ set_renderer()

void set_renderer ( std::shared_ptr< Renderer > r )