ModelViewerI Class Reference

Interface for the SDFormat Editor's 3D Model Vewer. More...

#include <model_viewer_interface.h>

Inheritance diagram for ModelViewerI:

Collaboration diagram for ModelViewerI:

Classes
struct	ModelInfo
	Struct representing information of a model's visual information. More...
struct	PresetModelInfo
	Struct representing information of a model's visual information for pre-defined shapes. More...

Public Types
enum	PresetType { BOX , CYLINDER , SPHERE }
	Preset shapes which do not require a mesh to be provided in the sdf.

Public Member Functions
virtual void	Initialize ()=0
	Initialization of the Model Viewer.
virtual void	RenderFrame ()=0
	Rander a single frame.
virtual void	Quit ()=0
	Tells the model viewer to quit on its next iteration.
virtual void	AddModel (ModelInfo model_info)=0
	Add a model to the model viewer, the model will be rendered on the next frame.
virtual void	AddModel (PresetModelInfo model_info)=0
	Add a model to the model viewer, the model will be rendered on the next frame.
virtual void	ResetModels ()=0
	Sets a flag in the model viewer to remove the models in the scene.
virtual bool	IsRunning ()=0
	Indicates if the model viewer is running.
virtual std::mutex &	GetMutex ()=0
	Method to get the model viewer's mutex.

Detailed Description

Interface for the SDFormat Editor's 3D Model Vewer.

Member Function Documentation

AddModel() [1/2]

virtual void ModelViewerI::AddModel ( ModelInfo  model_info )

pure virtual

Add a model to the model viewer, the model will be rendered on the next frame.

Parameters

[in]

model_info

The model information

Implemented in ModelViewer.

AddModel() [2/2]

virtual void ModelViewerI::AddModel ( PresetModelInfo  model_info )

pure virtual

Add a model to the model viewer, the model will be rendered on the next frame.

Parameters

[in]

model_info

The preset model information

Implemented in ModelViewer.

GetMutex()

virtual std::mutex & ModelViewerI::GetMutex ( )

pure virtual

Method to get the model viewer's mutex.

Implemented in ModelViewer.

Initialize()

virtual void ModelViewerI::Initialize ( )

pure virtual

Initialization of the Model Viewer.

Implemented in ModelViewer.

IsRunning()

virtual bool ModelViewerI::IsRunning ( )

pure virtual

Indicates if the model viewer is running.

Returns

a boolean

Implemented in ModelViewer.

Quit()

virtual void ModelViewerI::Quit ( )

pure virtual

Tells the model viewer to quit on its next iteration.

Implemented in ModelViewer.

RenderFrame()

virtual void ModelViewerI::RenderFrame ( )

pure virtual

Rander a single frame.

Implemented in ModelViewer.

ResetModels()

virtual void ModelViewerI::ResetModels ( )

pure virtual

Sets a flag in the model viewer to remove the models in the scene.

Implemented in ModelViewer.

---

The documentation for this class was generated from the following file:

• include/interfaces/model_viewer_interface.h