Rendering a Scene

• RenderManager
  • StartRender()
• RenderingAPI
  • Render Output Location
    • GetPlugin()
    • GetPluginNames()
    • RenderOutputLocationPlugin
      • RenderOutputLocationPlugin.computeFilePath()
      • RenderOutputLocationPlugin.computeLocation()
      • RenderOutputLocationPlugin.getLocationSettingsAttr()
  • Render Outputs
    • GetDefaultRendererSettingsAttr()
    • GetRenderOutputs()
  • Render Plugins
    • GetAllRenderMethods()
    • GetBatchRenderMethodForRenderer()
    • GetDefaultRendererPluginName()
    • GetInfoPlugin()
    • GetInfoPluginName()
    • GetInfoPluginNameForShaderType()
    • GetOutputChannelAttr()
    • GetOutputChannelDynamicParameters()
    • GetOutputChannelGlobalStatementsAttr()
    • GetOutputChannelParameters()
    • GetProcessedParams()
    • GetRenderMethodByName()
    • GetRenderMethodForRendererAndMethodName()
    • GetRenderMethodsForRenderer()
    • GetRendererPluginDir()
    • GetRendererPluginDisplayColor()
    • GetRendererPluginDisplayName()
    • GetRendererPluginNameForShaderType()
    • GetRendererPluginNames()
    • GetRendererSettingsAttr()
    • GetRendererShaderTypeAttrPrefixes()
    • GetRendererShaderTypeParamsAttr()
    • GetRendererShaderTypeShaderAttr()
    • GetRendererShaderTypes()
    • SetRendererPluginDisplayColor()
    • SetRendererPluginDisplayName()
  • Renderer
    • GetPlugin()
    • ReleaseManager()
    • RendererPlugin
      • RendererPlugin.configureDiskRenderOutputProcess()
  • RendererInfo
    • FlushPluginCaches()
    • GetPlugin()
    • ReleaseManager()
    • RendererInfoPlugin
      • RendererInfoPlugin.addObjectLocation()
      • RendererInfoPlugin.clearObjectLocations()
      • RendererInfoPlugin.getBatchRenderMethod()
      • RendererInfoPlugin.getLiveRenderTerminalOps()
      • RendererInfoPlugin.getRegisteredRendererName()
      • RendererInfoPlugin.getRegisteredRendererVersion()
      • RendererInfoPlugin.getRenderMethods()
      • RendererInfoPlugin.getRenderTerminalOps()
      • RendererInfoPlugin.getRendererCoshaderType()
      • RendererInfoPlugin.getRendererObjectDefaultType()
      • RendererInfoPlugin.getRendererObjectInfo()
      • RendererInfoPlugin.getRendererObjectNames()
      • RendererInfoPlugin.getRendererObjectTypes()
      • RendererInfoPlugin.getRendererShaderTypeTags()
      • RendererInfoPlugin.getShaderInputNames()
      • RendererInfoPlugin.getShaderInputTags()
      • RendererInfoPlugin.getShaderOutputNames()
      • RendererInfoPlugin.getShaderOutputTags()
      • RendererInfoPlugin.isNodeTypeSupported()
      • RendererInfoPlugin.isPolymeshFacesetSplittingEnabled()
      • RendererInfoPlugin.isPresetLocalFileNeeded()
      • RendererInfoPlugin.setKatanaPath()
      • RendererInfoPlugin.setPluginPath()
      • RendererInfoPlugin.setPluginRootPath()
      • RendererInfoPlugin.setTmpPath()
      • RendererInfoPlugin.setTypeTagNameFilter()
    • RendererObjectInfo
      • RendererObjectInfo.getContainerHints()
      • RendererObjectInfo.getFullPath()
      • RendererObjectInfo.getLocation()
      • RendererObjectInfo.getName()
      • RendererObjectInfo.getOutputType()
      • RendererObjectInfo.getParam()
      • RendererObjectInfo.getParams()
      • RendererObjectInfo.getType()
      • RendererObjectInfo.getTypeTags()
    • RendererObjectParamInfo
      • RendererObjectParamInfo.getArraySize()
      • RendererObjectParamInfo.getDefault()
      • RendererObjectParamInfo.getEnums()
      • RendererObjectParamInfo.getHints()
      • RendererObjectParamInfo.getName()
      • RendererObjectParamInfo.getType()
• LiveRenderAPI
  • AppendTerminalOp()
  • ClearAllTerminalOps()
  • GetTerminalOps()
  • InsertTerminalOp()
  • RemoveTerminalOp()
  • RestoreDefaultTerminalOps()
  • SendCommand()
  • SendData()
  • SetLiveAttribute()
  • SetVirtualCameraAttributes()
  • RegisterActionClass()
  • GetRegisteredActionClasses()
• FarmAPI
  • Introduction to Katana’s FarmAPI
  • FarmAPI Example Code
  • FarmAPI Reference Documentation
    • FarmAPI Python Package
    • FarmAPI Constants
      • FarmAPI.NODES_ALL
      • FarmAPI.NODES_SELECTED
      • FarmAPI.NODES_SINGLE
    • Custom Farm Menu Commands
      • AddFarmMenuOption()
      • AddFarmPopupMenuOption()
      • GetFarmMenuOptions()
      • GetFarmPopupMenuOptions()
    • Custom Farm Settings
      • AddFarmSettingNumber()
      • AddFarmSettingNumberArray()
      • AddFarmSettingString()
      • AddFarmSettingStringArray()
      • GetAddedFarmSettings()
      • ExtractFarmSettingsFromNode()
      • FarmSetting
        • FarmSetting.NUMBER
        • FarmSetting.NUMBERARRAY
        • FarmSetting.QUALIFIER
        • FarmSetting.STRING
        • FarmSetting.STRINGARRAY
        • FarmSetting.VALID_TYPES
        • FarmSetting.__init__()
        • FarmSetting.getHints()
        • FarmSetting.getName()
        • FarmSetting.getQualifiedName()
        • FarmSetting.getShortName()
        • FarmSetting.getSize()
        • FarmSetting.getType()
        • FarmSetting.getValue()
    • Validity Checks
      • IsSceneValid()
      • AddWarningMessage()
      • AddErrorMessage()
      • GetWarningMessages()
      • GetErrorMessages()
    • Render Node Dependencies
      • GetSortedDependencies()
      • GetSortedDependencyList()
      • NodeRenderSettings
        • NodeRenderSettings.__init__()
        • NodeRenderSettings.getNode()
        • NodeRenderSettings.getNodeType()
      • RenderScriptSettings
        • RenderScriptSettings.__init__()
        • RenderScriptSettings.appendXML()
    • Creating Farm Files
      • WriteFarmFile()
      • OpenDefaultDialog()
    • FarmAPI Helper Functions
      • Initialise()
      • GetNodeProcessType()
      • GetClickedNode()
      • GetSelectedNodes()
      • GetCurrentNode()
      • GetNodeList()
      • GetSceneFrameRange()
      • GetCurrentNodeFrameRange()
      • GetKatanaFileName()
    • Render Farm Plug-ins
      • FarmAPI.FarmPluginManager Module
        • FarmPluginManagerException
        • JobRequest
          • JobRequest.__init__()
        • GetDefaultFarm()
        • SetDefaultFarm()
        • GetFarmPluginNames()
        • CreateRenderContextName()
        • CreateTemporaryDirectory()
        • CopyRenderFiles()
        • SubmitJob()
        • StartJob()
        • StopJob()
        • GetJobs()
        • GetRenderLogFilename()
        • GetJobState()
        • Initialize()
        • LoadFarmPlugins()
        • PrepareRemoteCommand()
• Katana Queue
  • Introduction to Katana Queue
  • kq and Agent Lifetime
  • Configuring the Number of Local Agents
  • Adding Remote Agents
    • Step 1: Preparing the Remote Machine
    • Step 2: Launching Remote Agents
    • Step 3: Stopping Remote Agents
    • Troubleshooting