Katana Plug-in APIs 0.1

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AlembicIn::AbcCook
Foundry::Katana::ArbitraryOutputAttr
AlembicIn::ArrayProp
Foundry::Katana::Util::AssertExceptionA class to represent an assertion error
Foundry::Katana::AssetPrimary class to derive from when implementing asset system plugin
Foundry::Katana::AssetTransactionVirtual base for asset transactions
AttrDataCache
Foundry::Katana::FnOpDescription::AttrDescriptionDescription of a generic Attribute
Foundry::Katana::AttributeThe base class of all Attributes
Foundry::Katana::AttributeFunction
Foundry::Katana::Util::AttributeKeyedCache< T, PointerT, Base >The AttributeKeyedCache is a templated class which takes an Attribute as a key and maps it to an instance of the templated type
Foundry::Katana::Util::AttributeKeyedCacheLockFree< T, PointerT >
Foundry::Katana::Util::AttributeKeyedCacheMutex< T, PointerT >
Foundry::Katana::AttributeSetOpArgsBuilder
Foundry::Katana::FnLookFile::AttrMap
Ball
BallComponent
BallLayer
Foundry::Katana::BaseGlobalAttributeProvider
Foundry::Katana::BaseGlobalAttributeProviderLegacy
Foundry::Katana::BoundPointUtility structure that can be used to represent a point in 3D space. Multiple points can be used to describe a bounding box
Foundry::Katana::FnGeolibCookInterfaceUtils::BuildLocalsAndGlobalsInfo
Foundry::Katana::RenderOutputUtils::CameraInfoCameraInfo
Foundry::Katana::Render::CameraSettingsA utility class which provides Katana's camera settings by parsing attribute data on camera scene graph locations. This class can be extended if renderer specific processing is required
Foundry::Katana::Render::RenderSettings::ChannelBuffer
Foundry::Katana::CloseMessageEncapsulates the message sent to Katana instructing it that there is no more data for the specified channel
Foundry::Katana::RendererInfo::CommandButtonLRCM
Foundry::Katana::Config
Foundry::Katana::ConstVector< T >Helper class used to wrap raw attribute data contained on the host side, with a stl::vector style interface
Foundry::Katana::ConstVectorBase< T >Helper class used to wrap raw attribute data contained on the host side
Foundry::Katana::Render::CopyAndConvertRenderActionA render action which renders to a temporary location and then performs a conversion based on the input parameters which include convert settings attributes. The converted file is then copied to the target location
Foundry::Katana::Render::CopyRenderActionA render action which renders to a temporary location and then copies the rendered file to the target location
Foundry::Katana::CreateLocationInfo
Foundry::Katana::DataAttributeThe base class of attributes containing data, possibly at multiple samples in time
Foundry::Katana::DataBuilder< ATTR >Helper class used for creating attributes
Foundry::Katana::DataMessageEncapsulates the message sent to the Katana Catalog Server (KCS) which actually contains image data for a given channel
Foundry::Katana::DefaultAssetPluginAllows the access to the currently set Asset Management System plugin
Foundry::Katana::DefaultAttributeProducer
Foundry::Katana::DefaultFileSequencePluginAllows the access to the currently set File Sequence plugin
Foundry::Katana::RendererInfo::DiskRenderMethod..
Foundry::Katana::Render::DiskRenderOutputProcessConfigures the render process for disk renders and defines how render outputs are managed
Foundry::Katana::DoubleAttributeA class representing a data attribute containing double-precision floats
Foundry::Katana::ViewerUtils::DrawableAn object that can be drawn on the Viewport
DrawableMesh
Foundry::Katana::EndOfRenderMessageEncapsulates the message sent to Katana instructing it that there is no more data for the specified channel and it can clear up any data structures that it maintains for this channel
Foundry::Katana::pystring_v1::os::path::EnvironmentInterface
ExampleSceneLayer
ExampleSpotlightLocator
ExampleSpotlightLocatorVDC
ExampleSpotlightLocatorViewportLayer
ExampleViewerDelegate
ExampleViewport
FileAsset
FileLocation
FilenameMatch
FileNameParts
FileReader
FileReaderFactory
FileSeq
Foundry::Katana::FileSequencePrimary class to derive from when implementing file sequence plugin
Foundry::Katana::FileSequenceArrayContainer class that holds a vector of FileSequence instances and a vector of non-sequence filenames
Foundry::Katana::RendererInfo::FilteredRecookButtonLRCM
Foundry::Katana::FloatAttributeA class representing a data attribute containing single-precision floats
FnArbitraryOutputAttrHostSuite_v1
Foundry::Katana::FnArgsFile
FnArgsFileHostSuite_v1ArgsFile host suite
FnAttributeFunctionSuite_v1AttributeFunction suite
Foundry::Katana::FnAttributeFunctionUtilProvides access to registered AttributeFunction plugins
FnAttributeFunctionUtilHostSuite_v1AttributeFunctionUtil host suite
FnAttributeHash
FnAttributeHostSuiteAttribute suite
FnAttributeSampleAccessorStorageObject that mediates access to the sample data of an FnAttribute
Foundry::Katana::ViewerUtils::FnBaseLocator
Foundry::Katana::ViewerUtils::FnBaseLocatorVDC
Foundry::Katana::ViewerUtils::FnBaseLocatorViewportLayer
FnBuiltInOpArgsUtilHostSuite_v1
FnConfigHostSuite_v1
FnDefaultAttributeProducerSuite_v1DefaultAttributeProducer suite
FnDisplayDriverHostSuite_v1Display Driver suite
Foundry::Katana::ViewerAPI::FnEventWrapperA Wrapper for UI events
Foundry::Katana::FnExpressionMath
FnExpressionMathHostSuite_v1
FnGeolibCookInterfaceSuite_v1GeolibCookInterface suite
Foundry::Katana::FnGeolibCookInterfaceUtils
FnGeolibCookInterfaceUtilsBuildLocalsAndGlobalsInfo
FnGeolibCookInterfaceUtilsFnMatchInfo
FnGeolibCookInterfaceUtilsHostSuite_v1GeolibCookInterfaceUtils host suite
FnGeolibCookInterfaceUtilsHostSuite_v2
FnGeolibCookInterfaceUtilsMatchesCELInfo
FnGeolibGlobalAttributeProviderContextDefault
FnGeolibOpSuite_v1GeolibOp suite
FnGeolibRuntimeFactoryHostSuite_v2Runtime suite
FnGeolibRuntimeSuite_v2Runtime suite
FnGeolibSetupInterfaceSuite_v1GeolibSetupInterface suite
Foundry::Katana::FnHintUtil
FnHintUtilHostSuite_v1HintUtil host suite
Foundry::Katana::FnLog
FnLoggingHostSuite_v1
Foundry::Katana::FnLogQueue
Foundry::Katana::FnLogQueueEntry
Foundry::Katana::FnLookFile
FnLookFileHostSuite_v1LookFile host suite
FnLookFileHostSuite_v2
FnManipulatorHandleHostSuite_v1
FnManipulatorHandlePluginSuite_v1
FnManipulatorHostSuite_v1
FnManipulatorHostSuite_v2
FnManipulatorPluginSuite_v1
Foundry::Katana::Util::Path::FnMatchInfo
Foundry::Katana::FnMaterialResolveUtil
FnMaterialResolveUtilHostSuite_v1MaterialResolveUtil host suite
Foundry::Katana::FnOpDescription::FnOpDescriptionBuilderHelper class for building attributes in Op describe() functions
FnOptionIdGeneratorHostSuite_v1
FnPluginThe basic plug-in information that must be returned from a call to getPlugins()
FnPluginHostThe basic host information that will be provided to a plug-in by setHost()
FnPluginManagerHostSuite_v1
Foundry::Katana::FnRendererInfoPlugin
Foundry::Katana::FnRendererObjectInfo
Foundry::Katana::FnRenderOutputLocationPluginClient
FnRenderOutputLocationPluginSuite_v1
FnRenderOutputLocationPluginSuite_v2
FnRenderPluginSuite_v1
FnRenderPluginSuite_v2
FnRenderServicesSuite_v1
Foundry::Katana::FnResolutionTableEntry
FnResolutionTableHostSuite_v1ResolutionTable host suite - read-only access to default resolution table
Foundry::Katana::FnResourceFiles
FnResourceFilesHostSuite_v1ResourceFiles host suite
Foundry::Katana::FnScenegraphIteratorThe Scenegraph Iterator that 'points' at a location in a scenegraph
FnScenegraphLocationDelegatePluginSuite_v1
FnSgIteratorHostSuite_v2
FnSgIteratorHostSuite_v3
FnViewerDelegateComponentHostSuite_v2
FnViewerDelegateComponentPluginSuite_v2
FnViewerDelegateHostSuite_v2
FnViewerDelegateHostSuite_v3
FnViewerDelegateHostSuite_v4
FnViewerDelegatePluginSuite_v3
FnViewerLocationEventStruct
FnViewportCameraHostSuite_v1
FnViewportCameraHostSuite_v2
FnViewportCameraPluginSuite_v1
FnViewportCameraPluginSuite_v2
FnViewportHostSuite_v3
FnViewportLayerHostSuite_v2
FnViewportLayerPluginSuite_v2
FnViewportPluginSuite_v2
Foundry::Katana::FnXFormUtil
FnXFormUtilHostSuite_v1
Foundry::Katana::GeolibCookInterfaceProvides a unified interface for querying and manipulating the scene graph
Foundry::Katana::GeolibOp
Foundry::Katana::GeolibPrivateDataConvenience base class that can be derived from to allow users who require private data in their Ops
Foundry::Katana::GeolibSetupInterfaceProvides functions to allow an Op to configure how it's scheduled and evaluated by the Runtime
GLCoiHandleThis handle is not interactive and its only purpose is to render the lines that connect objects and their center of interest
GLCoiManipulator
Foundry::Katana::ViewerUtils::GLManipulatorA base class for a GL based Manipulator
Foundry::Katana::ViewerUtils::GLManipulatorHandleA base class for a GL based ManipulatorHandle
Foundry::Katana::Render::GlobalSettingsA utility class which provides a renderer's global settings from the Katana recipe if they are used. The attributes can be found on the root scene graph location at [rendererName]GlobalStatements. This class is a placeholder and can be extended to provide renderer specific parsing and access functions
GLRotateAxisHandleA handle to rotate the selected object along an axis
GLRotateBallHandleA handle to rotate the selected object in 2 degrees of freedom
GLRotateManipulator
GLScaleAxisHandleA handle to scale the selected object along an axis
GLScaleManipulator
GLScalePlaneHandleA handle to scale the selected object along YZ, XZ and XY planes
GLScaleUniformHandleA handle to scale the selected object uniformly in 3 dimensions
Foundry::Katana::ViewerUtils::GLShaderProgram
Foundry::Katana::ViewerUtils::GLStateRestoreProvide a RAII mechanism to temporarily change the OpenGL state
Foundry::Katana::ViewerUtils::GLTransformManipulatorA base class for a GL based Transform Manipulator
Foundry::Katana::ViewerUtils::GLTransformManipulatorHandleA base class for a GL based Transform ManipulatorHandle
GLTranslateAxisHandleA handle to translate the selected object along an axis
GLTranslateManipulator
GLTranslatePlaneHandleA handle to translate the selected object along YZ, XZ and XY planes
GLTranslateScreenPlaneHandle
Foundry::Katana::GroupAttributeA class representing a group attribute, used for hierarchically encapsulating other attributes
Foundry::Katana::GroupBuilderA factory class for constructing GroupAttribute objects
Foundry::Katana::Hash
Foundry::Katana::Render::IdSenderInterfaceAn interface for sending (ID, scene graph location name) pairs to Katana. This mapping is then used by the color picker to map a picked ID value in the monitor to the name of the corresponding scene graph location
IgnoreComponentA ViewerDelegateComponent that ignores locations and location types
AlembicIn::IndexedGeomParamPair
Foundry::Katana::FnOpDescription::InputAttrDescriptionDescription of an Attribute queried as an input through a call to interface.getAttr()
Foundry::Katana::IntAttributeA class representing a data attribute containing integers
KatanaAttrFileReader
Foundry::Katana::KatanaPipeThe KatanaPipe is used to send messages to the specified Katana Catalog Server
Foundry::Katana::LazyHostSuite< SuiteT >
Foundry::Katana::RendererInfo::LiveRenderButtonWidget
Foundry::Katana::RendererInfo::LiveRenderControlModule
Foundry::Katana::RendererInfo::LiveRenderFilter
Foundry::Katana::RendererInfo::LiveRenderMethod..
Foundry::Katana::RendererInfo::LiveRenderUserInterfacePolicy
LocalLocation
LoggingComponentA ViewerDelegateComponent that logs its member function calls
Foundry::Katana::ViewerAPI::ManipulatorManipulator plug-in base class
Foundry::Katana::ViewerAPI::ManipulatorHandleTo be extended by plugins
Foundry::Katana::ViewerAPI::ManipulatorHandlePluginBaseInterface for a Viewer Manipulator Handle
Foundry::Katana::ViewerAPI::ManipulatorHandleWrapperThe ManipulatorHandle class accessed by other plugins
Foundry::Katana::ViewerAPI::ManipulatorPluginBaseInterface for a Viewer Manipulator
Foundry::Katana::ViewerAPI::ManipulatorWrapperWrapper class for a Manipulator plug-in
Foundry::Katana::FnGeolibCookInterfaceUtils::MatchesCELInfo
Foundry::Katana::ViewerAPI::Matrix44< T >
Foundry::Katana::MessageThis is the base class against which all Messages sent to Katana should inherit from
Foundry::Katana::NewChannelMessageEncapsulates the message sent to the Katana Catalog Server (KCS) to specify that a new channel should be reserved in the Catalog for a given frame
Foundry::Katana::NewChannelMessage_v2Encapsulates the message sent to Katana indicating that a new channel should be reserved in the Catalog for a given frame
Foundry::Katana::NewFrameMessageEncapsulates the message sent to the Katana Catalog Server (KCS) to specify that a new frame should be reserved in the Catalog
Foundry::Katana::Render::NoOutputRenderActionA render action which does not specify any output locations
Foundry::Katana::NullAttributeA class representing a null value
Foundry::Katana::FnOpDescription::OpArgDescriptionDescription of an Attribute used as an opArg
AlembicIn::OpArgs
Foundry::Katana::FnOpDescription::OptionalAttrDescriptionDescription of an Attribute that can be optional
Foundry::Katana::ViewerAPI::OptionIdGenerator
Foundry::Katana::FnOpDescription::OutputAttrDescriptionDescription of an Attribute output as a result to the output scene graph through a call to interface.setAttr()
Foundry::Katana::FnRendererObjectInfo::ParamInfo
Foundry::Katana::ViewerAPI::PickedAttrsMap
Foundry::Katana::PipeSingletonThe PipeSingleton provides a singleton wrapper around the KatanaPipe
Foundry::Katana::PluginManager
Foundry::Katana::Render::PostCommandsRenderActionA render action which renders to a temporary location and then runs post commands to process image and copy to target render location
Foundry::Katana::RendererInfo::PreviewRenderMethod..
Foundry::Katana::RenderOutputUtils::ProceduralOutputContextInfo
Foundry::Katana::GeolibCookInterface::QueryAbortExceptionThrown by the Runtime to abort the current
Foundry::Katana::RendererInfo::RecookButtonLRCM
Foundry::Katana::RendererInfo::RecookLRCM
Foundry::Katana::RendererInfo::RecookPolicyLRCM
Foundry::Katana::Render::RenderActionA render action which renders directly to the target location
Foundry::Katana::Render::RenderBaseThe base class for the render plug-in which takes a Katana recipe and converts it into the renderer's language
Foundry::Katana::RendererInfo::RenderConfigurationPolicyLRCM
Foundry::Katana::RendererInfo::RendererInfoBaseThe renderer info plug-in provides Katana with renderer specific information such as shaders and render outputs, as well as configuring how a render is launched
ProfilingMockRenderer::RendererInfoPluginThis plug-in registers and defines the Profiling Mock Renderer render plug-in
RendererInfoPluginSuite_v1
RendererInfoPluginSuite_v2
Foundry::Katana::RendererInfo::RenderMethod..
Foundry::Katana::Render::RenderSettings::RenderOutput
RenderOutputUtilsSuite_v2
RenderOutputUtilsSuite_v3
ProfilingMockRenderer::RenderPluginThe Profiling Mock Renderer is a mock renderer plug-in that provides scene traversal profiling information
Foundry::Katana::Render::RenderSettingsA utility class which represents a collection of render settings which originate from the renderSettings attributes and other relevant modules. This class can be extended if renderer specific processing is required
Foundry::Katana::Sample< ValueT >
Foundry::Katana::SampleAccessor< ValueT >
Foundry::Katana::SampleAccessorBase< ValueT >
Foundry::Katana::SampleIterator< ValueT >
AlembicIn::ScalarProp
Foundry::Katana::Render::ScenegraphLocationDelegateSuper-Class that enables the creation of user-defined sub-classes and plug-ins responsible for processing/rendering different location types
SceneNode
Sequence
SequenceMatch
Foundry::Katana::RendererInfo::ShaderInfoCache< TShaderInfoType >Caches a map of shader names and attributes for quick access by Renderer Info Plug-ins
Foundry::Katana::RenderOutputUtils::ShadingNodeConnectionDescriptionShadingNodeConnectionDescription
Foundry::Katana::RenderOutputUtils::ShadingNodeDescriptionShadingNodeDescription
Foundry::Katana::RenderOutputUtils::ShadingNodeDescriptionMapShadingNodeDescriptionMap
Foundry::Katana::SimpleActionSimple action base class for performing an action (doit) and rolling it back (rollback) in case of error in this or subsequent action
Foundry::Katana::SimpleTransactionSimple transaction maintains a list of actions. If an action returns failure during commit, execution is canceled and rollback() is called on all previously executed actions in transaction
Foundry::Katana::ViewerUtils::SnappingDataSnapping data
SnappingTexturesA handle to translate the selected object along the screen plane
Foundry::Katana::Render::SocketIdSender
Foundry::Katana::Render::SocketIdSender::SocketIdSenderException
Foundry::Katana::StaticSceneCreateOpArgsBuilder
Foundry::Katana::StringAttributeA class representing a data attribute containing strings
CompanyName::Katana::TemplateRendererInfoPluginTemplate RendererInfo Plugin
CompanyName::Katana::TemplateRenderPluginTemplate Render Plugin
Foundry::Katana::Render::TemporaryRenderActionA render action which renders to a temporary location
Foundry::Katana::RenderOutputUtils::Transform
Foundry::Katana::UniqueStringBuilder
Foundry::Katana::ViewerAPI::Vec2< T >
Foundry::Katana::ViewerAPI::Vec3< T >
Foundry::Katana::ViewerAPI::Vec4< T >
Foundry::Katana::ViewerAPI::ViewerDelegateTo be extended by plugins
Foundry::Katana::ViewerAPI::ViewerDelegateComponentTo be extended by plugins
Foundry::Katana::ViewerAPI::ViewerDelegateComponentPluginBaseExtends the functionality of an existing ViewerDelegate
Foundry::Katana::ViewerAPI::ViewerDelegateComponentWrapperThe ViewerDelegateComponent class accessed by other plugins
Foundry::Katana::ViewerAPI::ViewerDelegatePluginBaseMain data source for a Viewer that feeds the different Viewports
Foundry::Katana::ViewerAPI::ViewerDelegateWrapperThe ViewerDelegate class accessed by other plugins
Foundry::Katana::ViewerAPI::ViewerLocationEventStruct describing a Viewer Location Event
Foundry::Katana::ViewerAPI::ViewerLocationStateChangesStruct containing Viewer Location Event state changes
Foundry::Katana::ViewerAPI::ViewportTo be extended by plugins
Foundry::Katana::ViewerAPI::ViewportCameraTo be extended by plugins
Foundry::Katana::ViewerAPI::ViewportCameraPluginBaseInterface for a camera
Foundry::Katana::ViewerAPI::ViewportCameraWrapperThe ViewportCamera class accessed by other plugins
Foundry::Katana::ViewerAPI::ViewportLayerTo be extended by plugins
Foundry::Katana::ViewerAPI::ViewportLayerPluginBaseInterface for a layer in the Viewport
Foundry::Katana::ViewerAPI::ViewportLayerWrapperThe ViewportLayer class accessed by other plugins
Foundry::Katana::ViewerAPI::ViewportPluginBaseInterface for the functionality of a single viewport
Foundry::Katana::ViewerAPI::ViewportWrapperThe Viewport class accessed by other plugins
Foundry::Katana::RenderOutputUtils::XFormMatrix..
 All Classes Functions Variables Typedefs Enumerations Enumerator