CompanyName::Katana::TemplateRendererInfoPlugin Class Reference

Template RendererInfo Plugin. More...

#include <TemplateRendererInfoPlugin.h>

Inheritance diagram for CompanyName::Katana::TemplateRendererInfoPlugin:

List of all members.

Public Member Functions
void	fillRenderMethods (std::vector< FnKat::RendererInfo::RenderMethod * > &renderMethods) const
void	fillRendererObjectNames (std::vector< std::string > &rendererObjectNames, const std::string &type, const std::vector< std::string > &typeTags) const
void	fillRendererObjectTypes (std::vector< std::string > &renderObjectTypes, const std::string &type) const
void	configureBatchRenderMethod (FnKat::RendererInfo::DiskRenderMethod &batchRenderMethod) const
std::string	getRegisteredRendererName () const
std::string	getRegisteredRendererVersion () const
std::string	getRendererObjectDefaultType (const std::string &type) const
bool	isPresetLocalFileNeeded (const std::string &outputType) const
bool	isNodeTypeSupported (const std::string &nodeType) const
bool	isPolymeshFacesetSplittingEnabled () const
void	fillShaderInputNames (std::vector< std::string > &shaderInputNames, const std::string &shaderName) const
void	fillShaderInputTags (std::vector< std::string > &shaderInputTags, const std::string &shaderName, const std::string &inputName) const
void	fillShaderOutputNames (std::vector< std::string > &shaderOutputNames, const std::string &shaderName) const
void	fillShaderOutputTags (std::vector< std::string > &shaderOutputTags, const std::string &shaderName, const std::string &outputName) const
void	fillRendererShaderTypeTags (std::vector< std::string > &shaderTypeTags, const std::string &shaderType) const
std::string	getRendererCoshaderType () const
bool	buildRendererObjectInfo (FnKat::GroupBuilder &rendererObjectInfo, const std::string &name, const std::string &type, const FnKat::GroupAttribute inputAttr) const
void	flushCaches ()

---

Detailed Description

Template RendererInfo Plugin.

---

Member Function Documentation

bool CompanyName::Katana::TemplateRendererInfoPlugin::buildRendererObjectInfo	(	FnKat::GroupBuilder &	rendererObjectInfo,
		const std::string &	name,
		const std::string &	type,
		const FnKat::GroupAttribute	inputAttr
	)		const [virtual]

buildRendererObjectInfo

Implements Foundry::Katana::RendererInfo::RendererInfoBase.

void CompanyName::Katana::TemplateRendererInfoPlugin::configureBatchRenderMethod

(

FnKat::RendererInfo::DiskRenderMethod &

batchRenderMethod

)

const [virtual]

configureBatchRenderMethod

Implements Foundry::Katana::RendererInfo::RendererInfoBase.

void CompanyName::Katana::TemplateRendererInfoPlugin::fillRendererObjectNames	(	std::vector< std::string > &	rendererObjectNames,
		const std::string &	type,
		const std::vector< std::string > &	typeTags
	)		const [virtual]

fillRendererObjectNames

Implements Foundry::Katana::RendererInfo::RendererInfoBase.

void CompanyName::Katana::TemplateRendererInfoPlugin::fillRendererObjectTypes	(	std::vector< std::string > &	renderObjectTypes,
		const std::string &	type
	)		const [virtual]

fillRendererObjectTypes

Implements Foundry::Katana::RendererInfo::RendererInfoBase.

void CompanyName::Katana::TemplateRendererInfoPlugin::fillRendererShaderTypeTags	(	std::vector< std::string > &	shaderTypeTags,
		const std::string &	shaderType
	)		const [virtual]

fillRendererShaderTypeTags

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

void CompanyName::Katana::TemplateRendererInfoPlugin::fillRenderMethods

(

std::vector< FnKat::RendererInfo::RenderMethod * > &

renderMethods

)

const

fillRenderMethods

void CompanyName::Katana::TemplateRendererInfoPlugin::fillShaderInputNames	(	std::vector< std::string > &	shaderInputNames,
		const std::string &	shaderName
	)		const [virtual]

Shader Inputs / Outputs

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

void CompanyName::Katana::TemplateRendererInfoPlugin::fillShaderInputTags	(	std::vector< std::string > &	shaderInputTags,
		const std::string &	shaderName,
		const std::string &	inputName
	)		const [virtual]

fillShaderInputTags

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

void CompanyName::Katana::TemplateRendererInfoPlugin::fillShaderOutputNames	(	std::vector< std::string > &	shaderOutputNames,
		const std::string &	shaderName
	)		const [virtual]

fillShaderOutputNames

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

void CompanyName::Katana::TemplateRendererInfoPlugin::fillShaderOutputTags	(	std::vector< std::string > &	shaderOutputTags,
		const std::string &	shaderName,
		const std::string &	outputName
	)		const [virtual]

fillShaderOutputTags

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

void CompanyName::Katana::TemplateRendererInfoPlugin::flushCaches

(

)

[virtual]

flushCaches

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

std::string CompanyName::Katana::TemplateRendererInfoPlugin::getRegisteredRendererName

(

)

const [virtual]

Registered renderer name that corresponds to this renderer info

Returns:

The name of the renderer plug-in that corresponds to this renderer info plug-in

Implements Foundry::Katana::RendererInfo::RendererInfoBase.

std::string CompanyName::Katana::TemplateRendererInfoPlugin::getRegisteredRendererVersion

(

)

const [virtual]

Registered version of the renderer this renderer info is used with.

Returns:

The renderer version

See also:

getRegisteredRendererName

Implements Foundry::Katana::RendererInfo::RendererInfoBase.

std::string CompanyName::Katana::TemplateRendererInfoPlugin::getRendererCoshaderType

(

)

const [virtual]

getRendererCoshaderType

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

std::string CompanyName::Katana::TemplateRendererInfoPlugin::getRendererObjectDefaultType

(

const std::string &

type

)

const [virtual]

getRendererObjectDefaultType

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

bool CompanyName::Katana::TemplateRendererInfoPlugin::isNodeTypeSupported

(

const std::string &

nodeType

)

const [virtual]

Katana will call this function to determine if the renderer supports specific nodes. Currently ShadingNode and OutputChannelDefine will be queried. True should be returned if the renderer supports this node type.

Returns:

true if the node type is supported, false otherwise

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

bool CompanyName::Katana::TemplateRendererInfoPlugin::isPolymeshFacesetSplittingEnabled

(

)

const [virtual]

Declares if polymesh faces are split into sub-meshes where each mesh represents a single face set as required by some renderers.

Returns:

true if splitting is enabled, false otherwise

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

bool CompanyName::Katana::TemplateRendererInfoPlugin::isPresetLocalFileNeeded

(

const std::string &

outputType

)

const [virtual]

Declares if a renderer output requires a pre-declared temp file (accessible in scene graph with implicit resolvers).

Parameters:

outputType

A render output type

Returns:

true if a local file is needed, false otherwise

Reimplemented from Foundry::Katana::RendererInfo::RendererInfoBase.

---

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

• TemplateRendererInfoPlugin.h