Katana Plug-in APIs 0.1
Public Member Functions | Static Public Member Functions

ProfilingMockRenderer::RendererInfoPlugin Class Reference

This plug-in registers and defines the Profiling Mock Renderer render plug-in. More...

#include <ProfilingMockRendererInfoPlugin.h>

Inheritance diagram for ProfilingMockRenderer::RendererInfoPlugin:
Foundry::Katana::RendererInfo::RendererInfoBase

List of all members.

Public Member Functions

 RendererInfoPlugin ()
 Constructor.
 ~RendererInfoPlugin () override
 Destructor.
void configureBatchRenderMethod (FnKat::RendererInfo::DiskRenderMethod &batchRenderMethod) const override
 Reimplemented from RendererInfoBase.
void fillRenderMethods (std::vector< FnKat::RendererInfo::RenderMethod * > &renderMethods) const override
 Reimplemented from RendererInfoBase.
void fillRendererObjectTypes (std::vector< std::string > &renderObjectTypes, const std::string &type) const override
 Reimplemented from RendererInfoBase.
void fillRendererObjectNames (std::vector< std::string > &rendererObjectNames, const std::string &type, const std::vector< std::string > &typeTags) const override
 Reimplemented from RendererInfoBase.
std::string getRegisteredRendererName () const override
 Reimplemented from RendererInfoBase.
std::string getRegisteredRendererVersion () const override
 Reimplemented from RendererInfoBase.
bool buildRendererObjectInfo (FnAttribute::GroupBuilder &rendererObjectInfo, const std::string &name, const std::string &type, const FnAttribute::GroupAttribute inputAttr) const override
 Reimplemented from RendererInfoBase.

Static Public Member Functions

static
FnKat::RendererInfo::RendererInfoBase
create ()
 Constructs an intance of the class.

Detailed Description

This plug-in registers and defines the Profiling Mock Renderer render plug-in.

The display name of the renderer is profilingMockRenderer. It supports Preview Render and Disk Render.

See also:
ProfilingMockRenderer::RenderPlugin

Member Function Documentation

bool ProfilingMockRenderer::RendererInfoPlugin::buildRendererObjectInfo ( FnAttribute::GroupBuilder rendererObjectInfo,
const std::string &  name,
const std::string &  type,
const FnAttribute::GroupAttribute  inputAttr 
) const [override, virtual]

Reimplemented from RendererInfoBase.

The Profiling Mock Renderer does not add extra renderer objects.

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

void ProfilingMockRenderer::RendererInfoPlugin::configureBatchRenderMethod ( FnKat::RendererInfo::DiskRenderMethod batchRenderMethod) const [override, virtual]

Reimplemented from RendererInfoBase.

The Batch Render method is always available. Although the Profiling Mock Renderer plug-in does not require any specific configuration, this function allows customization if needed.

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

static FnKat::RendererInfo::RendererInfoBase* ProfilingMockRenderer::RendererInfoPlugin::create ( ) [static]

Constructs an intance of the class.

This is used by the DEFINE_RENDERERINFO_PLUGIN macro.

Returns:
A pointer to the new instance.
void ProfilingMockRenderer::RendererInfoPlugin::fillRendererObjectNames ( std::vector< std::string > &  rendererObjectNames,
const std::string &  type,
const std::vector< std::string > &  typeTags 
) const [override, virtual]

Reimplemented from RendererInfoBase.

The Profiling Mock Renderer does not add extra renderer objects.

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

void ProfilingMockRenderer::RendererInfoPlugin::fillRendererObjectTypes ( std::vector< std::string > &  renderObjectTypes,
const std::string &  type 
) const [override, virtual]

Reimplemented from RendererInfoBase.

The Profiling Mock Renderer does not add extra renderer objects.

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

void ProfilingMockRenderer::RendererInfoPlugin::fillRenderMethods ( std::vector< FnKat::RendererInfo::RenderMethod * > &  renderMethods) const [override]

Reimplemented from RendererInfoBase.

Other render methods can be added here. Disk Render and Preview Render are the two methods (apart from the Batch Render method) that will be added for this plug-in.

Parameters:
renderMethodsOutput list where the new render methods will be added.
std::string ProfilingMockRenderer::RendererInfoPlugin::getRegisteredRendererName ( ) const [override, virtual]

Reimplemented from RendererInfoBase.

The Profiling Mock Renderer is registered as profilingMockRenderer.

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

std::string ProfilingMockRenderer::RendererInfoPlugin::getRegisteredRendererVersion ( ) const [override, virtual]

Reimplemented from RendererInfoBase.

This returns the version of the Profiling Mock Renderer plug-in.

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


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator