AnimationJob Class Reference

#include <RenderJobs.h>

Inheritance diagram for AnimationJob:

Public Member Functions
	AnimationJob (const std::string &name)
virtual std::string	className () const override
	Name representing the type of the job (e.e. "SPH"). More...
virtual UnorderedMap< std::string, ExtJobType >	getSlots () const override
	Lists all potential inputs of the job. More...
virtual UnorderedMap< std::string, ExtJobType >	requires () const override
	List of slots that need to be connected to evaluate the job. More...
virtual VirtualSettings	getSettings () override
	Returns a settings object which allows to query and modify the state of the job. More...
virtual void	evaluate (const RunSettings &global, IRunCallbacks &UNUSED(callbacks)) override
AutoPtr< IRenderPreview >	getRenderPreview (const RunSettings &global) const
AutoPtr< IRenderer >	getRenderer (const RunSettings &global) const
AutoPtr< IColorizer >	getColorizer (const RunSettings &global) const
RenderParams	getRenderParams () const
Public Member Functions inherited from INullJob
	INullJob (const std::string &name)
virtual Optional< ExtJobType >	provides () const override final
	Specifies the type of the job, i.e. what kind of data the job provides. More...
virtual JobContext	getResult () const override final
	Returns the result of the job. More...
Public Member Functions inherited from IJob
	IJob (const std::string &name)
virtual std::string	instanceName () const
	Unique name representing this job. More...
virtual void	evaluate (const RunSettings &global, IRunCallbacks &callbacks)=0
	Runs the operation provided by the job. More...
Public Member Functions inherited from Polymorphic
virtual	~Polymorphic ()

Additional Inherited Members
Protected Member Functions inherited from IJob
template<typename T >
SharedPtr< T >	getInput (const std::string &name) const
	Convenient function to return input data for slot of given name. More...
Protected Attributes inherited from IJob
std::string	instName
UnorderedMap< std::string, JobContext >	inputs
	Contains all input data, identified by names of input slots. More...

Detailed Description

Definition at line 45 of file RenderJobs.h.

Constructor & Destructor Documentation

AnimationJob()

AnimationJob::AnimationJob ( const std::string &  name )

explicit

Definition at line 42 of file RenderJobs.cpp.

Member Function Documentation

className()

virtual std::string AnimationJob::className ( ) const

inlineoverridevirtual

Name representing the type of the job (e.e. "SPH").

Implements IJob.

Definition at line 67 of file RenderJobs.h.

evaluate()

void AnimationJob::evaluate ( const RunSettings &  global, IRunCallbacks &  UNUSEDcallbacks  )

overridevirtual

Todo:

maybe also work with a copy of Gui ?

Todo:

how to report this? (don't do modal dialog)

Definition at line 250 of file RenderJobs.cpp.

getColorizer()

AutoPtr< IColorizer > AnimationJob::getColorizer

(

const RunSettings &

global

)

const

Todo:

Definition at line 443 of file RenderJobs.cpp.

getRenderer()

AutoPtr< IRenderer > AnimationJob::getRenderer

(

const RunSettings &

global

)

const

Definition at line 454 of file RenderJobs.cpp.

getRenderParams()

RenderParams AnimationJob::getRenderParams

(

)

const

Definition at line 239 of file RenderJobs.cpp.

getRenderPreview()

AutoPtr< IRenderPreview > AnimationJob::getRenderPreview

(

const RunSettings &

global

)

const

Definition at line 415 of file RenderJobs.cpp.

getSettings()

VirtualSettings AnimationJob::getSettings ( )

overridevirtual

Returns a settings object which allows to query and modify the state of the job.

It is not necessary to expose all state variables this way. This is mainly intended for (de)serialization of the job state and for connection with UI controls.

Implements IJob.

Definition at line 48 of file RenderJobs.cpp.

getSlots()

virtual UnorderedMap<std::string, ExtJobType> AnimationJob::getSlots ( ) const

inlineoverridevirtual

Lists all potential inputs of the job.

This is the superset of slots returned by function requires and it has to be fixed, i.e. cannot change when internal state of the job changes.

Implements IJob.

Definition at line 71 of file RenderJobs.h.

requires()

virtual UnorderedMap<std::string, ExtJobType> AnimationJob::requires ( ) const

inlineoverridevirtual

List of slots that need to be connected to evaluate the job.

The returned map shall contain names of the slots and their types. No two slots can have the same name. This list can can be changed, based on internal state of the job.

Reimplemented from IJob.

Definition at line 79 of file RenderJobs.h.

Member Data Documentation

finalAngle

Float AnimationJob::finalAngle = 360._f * DEG_TO_RAD

Definition at line 57 of file RenderJobs.h.

firstFile

Path AnimationJob::firstFile = Path("out_0000.ssf")

Definition at line 61 of file RenderJobs.h.

step

Float AnimationJob::step = 10._f * DEG_TO_RAD

Definition at line 56 of file RenderJobs.h.

---

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

• /home/pavel/projects/astro/sph/src/gui/objects/RenderJobs.h
• /home/pavel/projects/astro/sph/src/gui/objects/RenderJobs.cpp