RenderModelCommand Class Reference

Render Model command implementation of CommandI. More...

#include <RenderModelCommand.h>

Inheritance diagram for RenderModelCommand:

Collaboration diagram for RenderModelCommand:

Public Member Functions
	RenderModelCommand (std::shared_ptr< ModelViewerI > model_viewer, std::shared_ptr< SDFormatParserI > sdformat_parser, bool render_collisions_in_model_viewer)
	Constructor for render model command objects.

Private Member Functions
bool	Execute () override
	Implementation of interface method.
bool	ExecuteUndo () override
	Implementation of interface method.
bool	ExecuteRedo () override
	Implementation of interface method.
bool	IsUndoable () override
	Implementation of interface method.
bool	IsRedoable () override
	Implementation of interface method.
bool	IsThreaded (bool &prevent_user_input) override
	Implementation of interface method.
bool	ChangesProgramStateIrreversibly () override
	Implementation of interface method.

Private Attributes
std::shared_ptr< ModelViewerI >	model_viewer
	Pointer to the model viewer object.
std::shared_ptr< SDFormatParserI >	sdformat_parser
	Pointer to the SDFormat parser object.
bool	render_collisions_in_model_viewer
	Indicates if collisions should be rendered in the model viewer.

Detailed Description

Render Model command implementation of CommandI.

Constructor & Destructor Documentation

RenderModelCommand()

RenderModelCommand::RenderModelCommand	(	std::shared_ptr< ModelViewerI >	model_viewer,
		std::shared_ptr< SDFormatParserI >	sdformat_parser,
		bool	render_collisions_in_model_viewer
	)

Constructor for render model command objects.

Parameters

[in]	model_viewer	A pointer to the model viewer object
[in]	sdformat_parser	A pointer to the SDFormat parser object
[in]	render_collisions_in_model_viewer	A boolean to indicate wether or not to render collision objects

Member Function Documentation

ChangesProgramStateIrreversibly()

bool RenderModelCommand::ChangesProgramStateIrreversibly ( )

overrideprivatevirtual

Implementation of interface method.

Returns

Always false

Implements CommandI.

Execute()

bool RenderModelCommand::Execute ( )

overrideprivatevirtual

Implementation of interface method.

Returns

This command calls a method from the SDFormat Parser to obtain information about all the models in the sdf tree and then adds each model to a render queue on the model viewer, which runs on a seperate thread

Implements CommandI.

ExecuteRedo()

bool RenderModelCommand::ExecuteRedo ( )

overrideprivatevirtual

Implementation of interface method.

Returns

Always false

Implements CommandI.

ExecuteUndo()

bool RenderModelCommand::ExecuteUndo ( )

overrideprivatevirtual

Implementation of interface method.

Returns

Always false

Implements CommandI.

IsRedoable()

bool RenderModelCommand::IsRedoable ( )

overrideprivatevirtual

Implementation of interface method.

Returns

Always false

Implements CommandI.

IsThreaded()

bool RenderModelCommand::IsThreaded ( bool &  prevent_user_input )

overrideprivatevirtual

Implementation of interface method.

Parameters

[out]

prevent_user_input

indicates if user input should be prevented if this happens to be a threaded command

Returns

Always false

Implements CommandI.

IsUndoable()

bool RenderModelCommand::IsUndoable ( )

overrideprivatevirtual

Implementation of interface method.

Returns

Always false

Implements CommandI.

---

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

• include/commands/RenderModelCommand.h
• src/commands/RenderModelCommand.cpp