RenderConfig stores all the configuration settings used to render a scene. More...

#include <luxcore.h>

Public Member Functions
virtual	~RenderConfig ()

virtual const luxrays::Properties &	GetProperties () const =0
	Returns a reference to the Properties used to create the RenderConfig. More...

virtual const luxrays::Property	GetProperty (const std::string &name) const =0
	Returns the Property with the given name or the default value if it has not been defined. More...

virtual const luxrays::Properties &	ToProperties () const =0
	Returns a reference to all Properties (including default values) defining the RenderConfig. More...

virtual Scene &	GetScene () const =0
	Returns a reference to the Scene used in the RenderConfig. More...

virtual void	Parse (const luxrays::Properties &props)=0
	Sets configuration Properties with new values. This method can be used only when the RenderConfig is not in use by a RenderSession. More...

virtual void	Delete (const std::string &prefix)=0
	Deletes any configuration Property starting with the given prefix. This method can be used only when the RenderConfig is not in use by a RenderSession. More...

virtual bool	GetFilmSize (unsigned int filmFullWidth, unsigned int filmFullHeight, unsigned int *filmSubRegion) const =0
	Return the configured Film width, height, sub-region width, height, and if sub-region is enabled. More...

virtual void	DeleteSceneOnExit ()=0
	Delete the scene passed to the constructor when the class destructor is invoked. More...

virtual void	Save (const std::string &fileName)=0
	Save all the scene related information (the LuxCore RenderConfig, and Scene) in a file. More...

virtual void	Export (const std::string &dirName)=0
	Save all the scene related information (the LuxCore RenderConfig, and Scene) in a directory using text format for the SDL. This performs the same work of FILESAVER render engine. More...

Static Public Member Functions
static RenderConfig *	Create (const luxrays::Properties &props, Scene *scene=NULL)
	Create a new RenderConfig using the provided Properties and (optional) Scene. More...

static RenderConfig *	Create (const std::string &fileName)
	Create a new RenderConfig using the provided binary file. More...

static RenderConfig *	Create (const std::string &fileName, RenderState startState, Film startFilm)
	Create a new RenderConfig using the provided resume binary file. More...

static const luxrays::Properties &	GetDefaultProperties ()
	Returns a Properties container with all default values. More...

Detailed Description

RenderConfig stores all the configuration settings used to render a scene.

Definition at line 907 of file luxcore.h.

Constructor & Destructor Documentation

virtual luxcore::RenderConfig::~RenderConfig ( )

virtual

Member Function Documentation

static RenderConfig* luxcore::RenderConfig::Create	(	const luxrays::Properties &	props,
		Scene *	scene = `NULL`
	)

static

Create a new RenderConfig using the provided Properties and (optional) Scene.

Parameters

props	are the Properties used to build the new RenderConfig.
scene	is the Scene used to build the new RenderConfig. If specified, the Scene will not be deleted by the destructor. If NULL, the Scene will be read from the file specified in the "scene.file" Property and deleted by the destructor.

static RenderConfig* luxcore::RenderConfig::Create ( const std::string & fileName )

static

Create a new RenderConfig using the provided binary file.

Parameters

fileName is the binary file used to build the new RenderConfig. The extension for the binary format must be ".bcf".

static RenderConfig* luxcore::RenderConfig::Create	(	const std::string &	fileName,
		RenderState **	startState,
		Film **	startFilm
	)

static

Create a new RenderConfig using the provided resume binary file.

Parameters

fileName	is the binary file used to build the new RenderConfig. The extension for the binary format must be ".rsm".
startState	the pointer to the render state will be returned here.
startFilm	the pointer to the film will be returned here.

virtual void luxcore::RenderConfig::Delete ( const std::string & prefix )

pure virtual

Deletes any configuration Property starting with the given prefix. This method can be used only when the RenderConfig is not in use by a RenderSession.

Parameters

prefix is the prefix of the Properties to delete.

virtual void luxcore::RenderConfig::DeleteSceneOnExit ( )

pure virtual

Delete the scene passed to the constructor when the class destructor is invoked.

virtual void luxcore::RenderConfig::Export ( const std::string & dirName )

pure virtual

Save all the scene related information (the LuxCore RenderConfig, and Scene) in a directory using text format for the SDL. This performs the same work of FILESAVER render engine.

static const luxrays::Properties& luxcore::RenderConfig::GetDefaultProperties ( )

static

Returns a Properties container with all default values.

Returns: the default Properties.

virtual bool luxcore::RenderConfig::GetFilmSize	(	unsigned int *	filmFullWidth,
		unsigned int *	filmFullHeight,
		unsigned int *	filmSubRegion
	)		const

pure virtual

Return the configured Film width, height, sub-region width, height, and if sub-region is enabled.

Parameters

filmFullWidth	is where the configured Film width is returned if the pointer is not NULL.
filmFullHeight	is where the configured Film height is returned if the pointer is not NULL.
filmSubRegion	is an array of 4 values with the horizontal (followed by the vertical) begin and end of the Film region to render (in pixels).

Returns: true if there is a sub-region to render, false otherwise.

virtual const luxrays::Properties& luxcore::RenderConfig::GetProperties ( ) const

pure virtual

Returns a reference to the Properties used to create the RenderConfig.

Returns: the RenderConfig properties.

virtual const luxrays::Property luxcore::RenderConfig::GetProperty ( const std::string & name ) const

pure virtual

Returns the Property with the given name or the default value if it has not been defined.

Returns: the Property with the given name.

virtual Scene& luxcore::RenderConfig::GetScene ( ) const

pure virtual

Returns a reference to the Scene used in the RenderConfig.

Returns: the reference to the RenderConfig Scene.

virtual void luxcore::RenderConfig::Parse ( const luxrays::Properties & props )

pure virtual

Sets configuration Properties with new values. This method can be used only when the RenderConfig is not in use by a RenderSession.

Parameters

props are the Properties to set.

virtual void luxcore::RenderConfig::Save ( const std::string & fileName )

pure virtual

Save all the scene related information (the LuxCore RenderConfig, and Scene) in a file.

virtual const luxrays::Properties& luxcore::RenderConfig::ToProperties ( ) const

pure virtual

Returns a reference to all Properties (including default values) defining the RenderConfig.

Returns: the RenderConfig properties.

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

luxcore.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation