Foundry::Katana::Render::RenderAction Class Reference

A render action which renders directly to the target location. More...

#include <RenderAction.h>

Inheritance diagram for Foundry::Katana::Render::RenderAction:

List of all members.

Public Member Functions
	RenderAction (const std::string &renderTargetLocation)
void	setRenderTargetLocation (const std::string &renderTargetLocation)
void	setLoadOutputInMonitor (bool loadOutputInMonitor)
void	setForceOverwriteTarget (bool forceOverwriteTarget)
void	setCreateDestinationDirectories (bool createDestinationDirectories)

---

Detailed Description

A render action which renders directly to the target location.

---

Constructor & Destructor Documentation

Foundry::Katana::Render::RenderAction::RenderAction

(

const std::string &

renderTargetLocation

)

Parameters:

renderTargetLocation

The file location which is rendered to and then displayed in the monitor.

---

Member Function Documentation

void Foundry::Katana::Render::RenderAction::setCreateDestinationDirectories

(

bool

createDestinationDirectories

)

The rendered output creates any necessary directories required to satisfy the path specified for the final render location, unless this feature is disabled with this function.

Parameters:

createDestinationDirectories

Specifies whether or not the render output should create directories if the destination path does not exist. Default is true. If set to false, render will fail if target path doesn't exist.

void Foundry::Katana::Render::RenderAction::setForceOverwriteTarget

(

bool

forceOverwriteTarget

)

The rendered output overwrites the target file (even if it is set read-only) unless it is disabled with this function.

Parameters:

forceOverwriteTarget

Specifies whether or not the render output should forcibly overwrite any existing file. Default is true. If set to false, render will fail if target file is read-only.

void Foundry::Katana::Render::RenderAction::setLoadOutputInMonitor

(

bool

loadOutputInMonitor

)

The rendered output is loaded into the monitor and catalog by default unless it is disabled with this function (does not apply to batch rendering).

Parameters:

loadOutputInMonitor

Specifies whether or not the render output should be loaded in the monitor

void Foundry::Katana::Render::RenderAction::setRenderTargetLocation

(

const std::string &

renderTargetLocation

)

Set the target location of the file which will be rendered to. The rendered file will be read and displayed in the catalog and monitor unless setLoadOutputInMonitor is set to false.

Parameters:

renderTargetLocation

The file location which is rendered to and then displayed in the monitor.

---

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

• RenderAction.h