The Foundry Katana 3 0V3

–threads3d argument whenlaunching Katana where the value is sent to the render process.Render API¶enum RenderAPI::LiveRenderFilterMode¶Values:kLiveRenderFilterMode_Append¶kLiveRenderFilterMode_Replace¶enum RenderAPI::SceneGraphTraversalMode¶Values:kSceneGraphTraversalMode_LocationOrigin¶kSceneGraphTraversalMode_RecursiveFromSelection¶kSceneGraphTraversalMode_SelectedLocations¶kSceneGraphTraversalMode_SelectedLocationsRecursive¶enum RenderAPI::ProceduralArgsType¶Values:kProceduralArgsType_Classic¶kProceduralArgsType_ScenegraphAttr¶std::string Foundry::Katana::RenderOutputUtils::buildProceduralArgsString(FnScenegraphIterator sgIterator, ProceduralArgsType type, const std::string &argsAttrName, const ProceduralOutputContextInfo &contextInfo)¶void Foundry::Katana::RenderOutputUtils::flushProceduralDsoCaches(const std::string &apiName = "")¶flushProceduralDsoCaches int Foundry::Katana::RenderOutputUtils::getPixelAreaThroughCamera(FnScenegraphIterator sgIterator, const std::string &cameraName, const std::string &resolution)¶getPixelAreaThroughCamera void Foundry::Katana::RenderOutputUtils::findSampleTimesRelevantToShutterRange(std::vector &sampleTimes, const std::set &inputSamples, float shutterOpen, float shutterClose)¶findSampleTimesRelevantToShutterRange std::string Foundry::Katana::RenderOutputUtils::getRenderResolution(FnScenegraphIterator rootIterator, int *width, int *height)¶getRenderResolution std::string Foundry::Katana::RenderOutputUtils::getCameraPath(FnScenegraphIterator rootIterator)¶getCameraPath void Foundry::Katana::RenderOutputUtils::fillXFormListForLocation(std::vectorTransform> &xFormList, FnScenegraphIterator sgIterator, float shutterClose = 0.0f)¶fillXFormListForLocation bool Foundry::Katana::RenderOutputUtils::fillXFormListFromAttributes(std::vectorTransform> &xFormList, const FnAttribute::GroupAttribute &xformAttr, float shutterClose = 0.0f, bool invertMatrix = true)¶fillXFormListFromAttributes FnAttribute::GroupAttribute Foundry::Katana::RenderOutputUtils::convertTexturesToArbitraryAttr(const FnAttribute::GroupAttribute &texturesAttr)¶convertTexturesToArbitraryAttr FnAttribute::GroupAttribute Foundry::Katana::RenderOutputUtils::getFlattenedMaterialAttr(FnScenegraphIterator sgIterator, const FnAttribute::StringAttribute &terminalNamesAttr)¶getFlattenedMaterialAttr void Foundry::Katana::RenderOutputUtils::emptyFlattenedMaterialCache()¶emptyFlattenedMaterialCache CameraInfo Foundry::Katana::RenderOutputUtils::getCameraInfo(FnScenegraphIterator sgIterator, const std::string &cameraInfoPath)¶getCameraInfo Foundry::Katana::RenderOutputUtils::processLocation(FnScenegraphIterator sgIterator, const std::string &rendererName, const std::string &locationName, void *optionalInput, void **optionalOutput)¶Process a scene graph location for given a location type and renderer name. Looks up a scene graph location delegate plug-in given a location type and renderer name. If a plug-in is found the rendering/processing for this location is delegated to the plug-in where it operates on the corresponding scene graph iterator.Returntrue if a plug-in is found, false otherwise. ParameterssgIterator: - A scene graph iterator for the location to process. rendererName: - The name of the processor/renderer that should be used (can be empty to signify any-renderer). locationName: - The location type as retrieved from Foundry::Katana::SceneGraphIterator::getType() (must not empty). optionalInput: - Optional input data for the plug-in. optionalOutput: - Optional pointer that will point to the result of the processing/rendering. Foundry::Katana::RenderOutputUtils::fillDelegateHandledLocationTypesList(std::vector &delegateHandledLocationTypesList, const std::string &renderer = std::string())¶Returns a vector containing the location types for which there are

For a rendered object to Katana.Parametersid - Unique ID objectName - Scene graph location name class Foundry::Katana::Render::NoOutputRenderAction¶#include A render action which does not specify any output locations. Inherits from Foundry::Katana::Render::RenderActionPublic FunctionsNoOutputRenderAction()¶virtual ~NoOutputRenderAction()¶class Foundry::Katana::Render::PostCommandsRenderAction¶#include A render action which renders to a temporary location and then runs post commands to process image and copy to target render location. NoteThe temporary file is deleted unless the KATANA_KEEP_TEMP_RENDER_FILES environment variable is set. Inherits from Foundry::Katana::Render::CopyRenderActionPublic FunctionsPostCommandsRenderAction(const std::string &renderTargetLocation, const std::string &tempRenderLocation, const std::vector &postCommands)¶ParametersrenderTargetLocation - The file location which is read and displayed in the monitor. tempRenderLocation - The file location which is rendered to and then copied to the target location. postCommand - The external command to run to convert tempRenderLocation to renderTargetLocation. virtual ~PostCommandsRenderAction()¶virtual void buildAttribute(FnAttribute::GroupBuilder &builder) const¶void addCleanupFile(const std::string &cleanupFile)¶Protected Attributesstd::vector _postCommands¶std::vector _cleanupFiles¶class Foundry::Katana::Render::RenderAction¶#include A render action which renders directly to the target location. Subclassed by Foundry::Katana::Render::CopyRenderAction, Foundry::Katana::Render::NoOutputRenderAction, Foundry::Katana::Render::TemporaryRenderActionPublic FunctionsRenderAction(const std::string &renderTargetLocation)¶ParametersrenderTargetLocation - The file location which is rendered to and then displayed in the monitor. virtual ~RenderAction()¶virtual void buildAttribute(FnAttribute::GroupBuilder &builder) const¶void 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.ParametersrenderTargetLocation - The file location which is rendered to and then displayed in the monitor. void 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).ParametersloadOutputInMonitor - Specifies whether or not

SetSceneGraphDebugOutputSupported(bool sceneGraphDebugOutputSupported)¶virtual bool isSceneGraphDebugOutputSupported() const¶virtual void setDebugOutputFileType(const std::string &debugOutputFileType)¶virtual std::string getDebugOutputFileType() const¶virtual void setVisible(bool visible)¶virtual bool isVisible() const¶Protected Attributesstd::string _name¶std::string _label¶std::string _debugOutputFileType¶bool _createCatalogItem¶bool _reportRenderMessages¶bool _registerRender¶bool _debugOutputSupported¶bool _sceneGraphDebugOutputSupported¶bool _visible¶class Foundry::Katana::RendererInfo::DiskRenderMethod¶#include ... Inherits from Foundry::Katana::RendererInfo::RenderMethodPublic FunctionsDiskRenderMethod()¶DiskRenderMethod(const std::string &name, const std::string &label)¶virtual ~DiskRenderMethod()¶virtual std::string getType() const¶virtual void buildAttribute(FnAttribute::GroupBuilder &builder) const¶void setAllowWaitingForRenderCompletion(bool allowWaitingForRenderCompletion)¶bool isAllowWaitingForRenderCompletion() const¶Public Static Attributesconst char *kType¶const char *kDefaultLabel¶const char *kDefaultName¶const char *kBatchName¶Protected Attributesbool _allowWaitingForRenderCompletion¶class Foundry::Katana::RendererInfo::PreviewRenderMethod¶#include ... Inherits from Foundry::Katana::RendererInfo::RenderMethodPublic FunctionsPreviewRenderMethod()¶PreviewRenderMethod(const std::string &name, const std::string &label, bool allowConcurrentRenders = false)¶virtual ~PreviewRenderMethod()¶virtual std::string getType() const¶virtual void buildAttribute(FnAttribute::GroupBuilder &builder) const¶void setAllowConcurrentRenders(bool allowConcurrentRenders)¶bool isAllowConcurrentRenders() const¶Public Static Attributesconst char *kType¶const char *kDefaultLabel¶const char *kDefaultName¶Protected Attributesbool _allowConcurrentRenders¶class Foundry::Katana::RendererInfo::LiveRenderMethod¶#include ... Inherits from Foundry::Katana::RendererInfo::RenderMethodPublic FunctionsLiveRenderMethod()¶LiveRenderMethod(const std::string &name, const std::string &label)¶virtual ~LiveRenderMethod()¶virtual std::string getType() const¶virtual void buildAttribute(FnAttribute::GroupBuilder &builder) const¶Public Static Attributesconst char *kType¶const char *kDefaultLabel¶const char *kDefaultName¶template TShaderInfoType>class Foundry::Katana::RendererInfo::ShaderInfoCache¶#include Caches a map of shader names and attributes for quick access by Renderer Info Plug-ins. Public Typestypedef std::map::const_iterator Iterator¶Public Functionsbool isEmpty() const¶Queries whether the cache is empty.ReturnTrue if empty, false otherwise. void flush()¶Flush the cache, removing all data from it. void addShaderInfo(const std::string &shaderName, const TShaderInfoType &shaderInfo)¶Adds information about a single shader to the cache.ParametersshaderName - A string representing the unique name of the shader. shaderInfo - A group attribute holding information pertaining to the shader. const TShaderInfoType &getShaderInfo(const std::string &shaderName) const¶Allows access to information about a shader. ReturnIf information about the named shader was previously cached, that info is returned. Otherwise, an empty Group Attribute. ParametersshaderName - Unique name of the shader to retreive information for. ShaderInfoCache::Iterator begin() const¶Gets a

Const iterator to the first Shader’s information stored in the cache. ReturnConst iterator to first Shader’s information cache entry. ShaderInfoCache::Iterator end() const¶Gets a const iterator to the end of the cache. ReturnConst iterator to the end of the cache. void setNullValue(const TShaderInfoType &nullValue)¶Sets the null value, which is returned if a cache item is empty or unavailable. ParametersnullValue - The null value. class Foundry::Katana::RenderOutputUtils::CameraInfo¶#include CameraInfo. Public FunctionsCameraInfo(CameraInfoHandle handle)¶~CameraInfo()¶CameraInfo(const CameraInfo &rhs)¶CameraInfo &operator=(const CameraInfo &rhs)¶bool isValid() const¶isValid float getFov() const¶getFov float getNear() const¶getNear float getFar() const¶getFar float getLeft() const¶getLeft float getRight() const¶getRight float getTop() const¶getTop float getBottom() const¶getBottom int getOrtho() const¶getOrtho float getOrthoWidth() const¶getOrthoWidth double *getXForm() const¶getXForm Protected Functionsvoid acceptHandle(const CameraInfo &rhs)¶struct Foundry::Katana::RenderOutputUtils::ProceduralOutputContextInfo¶#include ProceduralOutputContextInfo Public FunctionsProceduralOutputContextInfo()¶Public Membersfloat _shutterOpen¶float _shutterClose¶float _cropWindowXMin¶float _cropWindowXMax¶float _cropWindowYMin¶float _cropWindowYMax¶int _xres¶int _yres¶struct Foundry::Katana::RenderOutputUtils::Transform¶#include Transform Public MembersTransformList transformList¶std::vector sampleTimes¶class Foundry::Katana::RenderOutputUtils::ShadingNodeConnectionDescription¶#include ShadingNodeConnectionDescription. Public FunctionsShadingNodeConnectionDescription(ShadingNodeConnectionDescriptionHandle handle)¶~ShadingNodeConnectionDescription()¶ShadingNodeConnectionDescription(const ShadingNodeConnectionDescription &rhs)¶ShadingNodeConnectionDescription &operator=(const ShadingNodeConnectionDescription &rhs)¶bool isValid() const¶isValid std::string getName() const¶getName std::string getConnectedNodeName() const¶getConnectedNodeName std::string getConnectedPortName() const¶getConnectedPortName Protected Functionsvoid acceptHandle(const ShadingNodeConnectionDescription &rhs)¶class Foundry::Katana::RenderOutputUtils::ShadingNodeDescription¶#include ShadingNodeDescription. Public FunctionsShadingNodeDescription(ShadingNodeDescriptionHandle handle)¶~ShadingNodeDescription()¶ShadingNodeDescription(const ShadingNodeDescription &rhs)¶ShadingNodeDescription &operator=(const ShadingNodeDescription &rhs)¶bool isValid() const¶isValid std::string getName() const¶getName std::string getType() const¶getType unsigned int getNumberOfParameterNames() const¶getNumberOfParameterNames std::string getParameterName(unsigned int index) const¶getParameterName FnAttribute::Attribute getParameter(const std::string &name) const¶getParameter unsigned int getNumberOfConnectionNames() const¶getNumberOfConnectionNames std::string getConnectionName(unsigned int index) const¶getConnectionName ShadingNodeConnectionDescription getConnection(const std::string &name) const¶getConnection Protected Functionsvoid acceptHandle(const ShadingNodeDescription &rhs)¶class Foundry::Katana::RenderOutputUtils::ShadingNodeDescriptionMap¶#include ShadingNodeDescriptionMap. Public FunctionsShadingNodeDescriptionMap(FnAttribute::GroupAttribute materialAttr)¶ShadingNodeDescriptionMap ShadingNodeDescriptionMap(FnScenegraphIterator sgIterator)¶ShadingNodeDescriptionMap ~ShadingNodeDescriptionMap()¶bool isValid() const¶isValid ShadingNodeDescription getShadingNodeDescriptionByName(const std::string &name) const¶getShadingNodeDescriptionByName class Foundry::Katana::RenderOutputUtils::XFormMatrix¶#include ... Public FunctionsXFormMatrix(const double *values)¶XFormMatrix XFormMatrix(const XFormMatrix &matrix)¶XFormMatrix const double *getValues() const¶getValues bool invert()¶invert