Viewer Plug-ins

• Getting Started Guide
  • Introduction
  • Viewer Structure Overview
  • Viewer Entities, Plug-ins and Utility classes
    • Plug-in Casting and cross compiler compatibility
    • Utility Classes
    • Registering Plug-ins
  • Glossary
  • Class Overviews
    • Viewer Tab (Python)
    • ViewportWidget (Python)
    • ViewerDelegate (C++)
    • ViewerDelegateComponent (C++)
    • Viewport (C++)
    • ViewportLayer (C++)
    • ViewportCamera (C++)
    • Manipulator (C++)
    • ManipulatorHandle (C++)
    • GLManipulator / GLManipulatorHandle and GLManipulatorLayer (C++)
    • FnEventWrapper (C++)
    • ViewerPluginExtension (Python)
    • OptionIdGenerator (C++)
    • CameraControlLayer (C++)
    • FnViewerUtils (C++)
    • Proxy Rendering
  • Overview: The Steps to Creating a Viewer
  • Example Viewer Plug-in
    • Building the Example Viewer plug-in
• Viewports
  • ViewportWrapperPtr
  • Foundry::Katana::ViewerAPI::ViewportPluginBase
    • ViewportPluginBase()
    • ~ViewportPluginBase()
    • getName()
    • getViewerDelegate()
    • getWidth()
    • getHeight()
    • getActiveCamera()
    • addCamera()
    • getCamera()
    • getCamera()
    • removeCamera()
    • removeCamera()
    • getNumberOfCameras()
    • getCameraName()
    • getCameraName()
    • getCameraIndex()
    • removeCamera()
    • setActiveCamera()
    • setViewFrozen()
    • isViewFrozen()
    • getViewMatrix()
    • getViewMatrix44d()
    • getProjectionMatrix()
    • getProjectionMatrix44d()
    • isDirty()
    • setDirty()
    • addLayer()
    • insertLayer()
    • getLayer()
    • getLayer()
    • removeLayer()
    • removeLayer()
    • getNumberOfLayers()
    • getLayerName()
    • getLayerIndex()
    • activateManipulator()
    • deactivateManipulator()
    • deactivateAllManipulators()
    • getNumberOfActiveManipulators()
    • getActiveManipulator()
    • getActiveManipulator()
    • makeGLContextCurrent()
    • doneGLContextCurrent()
    • isGLContextCurrent()
    • getDefaultFramebufferObject()
    • enableCap()
    • disableCap()
    • pick()
    • setPanAndZoomActive()
    • isPanAndZoomActive()
    • getHorizontalOffset()
    • getVerticalOffset()
    • getZoom()
  • Foundry::Katana::ViewerAPI::Viewport
    • Viewport()
    • ~Viewport()
    • setup()
    • cleanup()
    • event()
    • draw()
    • resize()
    • hover()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
    • freeze()
    • thaw()
    • getPrivateData()
    • pickerDraw()
    • customPick()
    • addPickableObject()
    • flush()
  • Foundry::Katana::ViewerAPI::ViewportWrapper
    • ViewportWrapper()
    • ~ViewportWrapper()
    • getPluginInstance()
    • event()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
• Viewport Layers
  • ViewportLayerWrapperPtr
  • Foundry::Katana::ViewerAPI::ViewportLayerPluginBase
    • ViewportLayerPluginBase()
    • ~ViewportLayerPluginBase()
    • getViewport()
    • hover()
    • pick()
  • Foundry::Katana::ViewerAPI::ViewportLayer
    • ViewportLayer()
    • ~ViewportLayer()
    • setup()
    • cleanup()
    • event()
    • draw()
    • resize()
    • hover()
    • freeze()
    • thaw()
    • getPrivateData()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
    • usesPickingOnHover()
    • pickerDraw()
    • customPick()
    • addPickableObject()
    • flush()
  • Foundry::Katana::ViewerAPI::ViewportLayerWrapper
    • ViewportLayerWrapper()
    • ~ViewportLayerWrapper()
    • getPluginInstance()
    • draw()
    • event()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
• Viewport Cameras
  • ViewportCameraWrapperPtr
  • Foundry::Katana::ViewerAPI::ViewportCameraPluginBase
    • CameraDirtyBits
      • Clean
      • DirtyParams
      • AllDirty
    • ViewportCameraPluginBase()
    • ~ViewportCameraPluginBase()
    • getViewport()
    • getViewMatrix()
    • getViewMatrix44d()
    • setViewMatrix()
    • getProjectionMatrix()
    • getProjectionMatrix44d()
    • setProjectionMatrix()
    • getCenterOfInterest()
    • setCenterOfInterest()
    • getFOV()
    • setFOV()
    • getOrthographicWidth()
    • setOrthographicWidth()
    • getNearFar()
    • setNearFar()
    • getScreenWindow()
    • setScreenWindow()
    • hasLocationPath()
    • getLocationPath()
    • setLocationPath()
    • getOrigin()
    • getDirection()
    • getUp()
    • getLeft()
    • isInteractionDisabled()
    • disableInteraction()
  • Foundry::Katana::ViewerAPI::ViewportCamera
    • ViewportCamera()
    • ~ViewportCamera()
    • getCameraTypeID()
    • setViewportDimensions()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
    • startInteraction()
    • endInteraction()
    • translate()
    • rotate()
    • setup()
    • asAttribute()
    • getPointOnPlane()
    • getRay()
    • projectObjectIntoWindow()
    • projectWindowIntoObject()
    • getPrivateData()
    • setDirty()
    • flush()
  • Foundry::Katana::ViewerAPI::ViewportCameraWrapper
    • ViewportCameraWrapper()
    • ~ViewportCameraWrapper()
    • getPluginInstance()
    • getCameraTypeID()
    • setViewportDimensions()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
    • translate()
    • rotate()
    • startInteraction()
    • endInteraction()
    • setup()
    • asAttribute()
    • getPointOnPlane()
    • getRay()
    • projectObjectIntoWindow()
    • projectWindowIntoObject()
    • setDirty()
• Viewer Location Events
  • Foundry::Katana::ViewerAPI::ViewerLocationStateChanges
    • ViewerLocationStateChanges()
    • ViewerLocationStateChanges()
    • locationRemoved
    • attributesUpdated
    • localXformUpdated
    • excludedChanged
    • descendantsHiddenChanged
  • Foundry::Katana::ViewerAPI::ViewerLocationEvent
    • ViewerLocationEvent()
    • ViewerLocationEvent()
    • getCStruct()
    • locationPath
    • attributes
    • localXformMatrix
    • localXformIsAbsolute
    • excluded
    • descendantsHidden
    • isVirtualLocation
    • stateChanges
• Viewer Delegates
  • ViewerDelegateWrapperPtr
  • Foundry::Katana::ViewerAPI::ViewerDelegatePluginBase
    • ViewerDelegatePluginBase()
    • ~ViewerDelegatePluginBase()
    • getAttributes()
    • getLocalXform()
    • getWorldXform()
    • getParentXform()
    • getPartialXform()
    • getLocalUsdXformOps()
    • openLocation()
    • openLocations()
    • closeLocation()
    • closeLocations()
    • activateSourceLocation()
    • activateSourceLocations()
    • deactivateSourceLocation()
    • deactivateSourceLocations()
    • selectLocation()
    • selectLocations()
    • getSelectedLocations()
    • addComponent()
    • insertComponent()
    • getComponent()
    • getComponent()
    • removeComponent()
    • removeComponent()
    • getNumberOfComponents()
    • getComponentName()
    • getComponentIndex()
    • getViewport()
    • getViewport()
    • getNumberOfViewports()
    • getViewportName()
    • getCompatibleManipulatorsInfo()
    • callPythonCallback()
    • getLiveAttributes()
    • getCookedAttributes()
    • setManipulatedAttribute()
    • openManipulationGroup()
    • closeManipulationGroup()
    • setBoundingBoxesEnabled()
    • areBoundingBoxesEnabled()
    • setProxyGeometryEnabled()
    • isProxyGeometryEnabled()
    • getDescendantLocations()
    • computeMergedExtent()
  • Foundry::Katana::ViewerAPI::ViewerDelegate
    • ViewerDelegate()
    • ~ViewerDelegate()
    • setup()
    • cleanup()
    • getBounds()
    • computeExtent()
    • getPrivateData()
    • locationEvent()
    • sourceLocationEvent()
    • usdPrimEvent()
    • locationsSelected()
    • usdPrimsSelected()
    • isProcessing()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
    • freeze()
    • thaw()
    • flush()
  • Foundry::Katana::ViewerAPI::ViewerDelegateWrapper
    • ViewerDelegateWrapper()
    • ~ViewerDelegateWrapper()
    • getPluginInstance()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
• Viewer Delegate Components
  • ViewerDelegateComponentWrapperPtr
  • Foundry::Katana::ViewerAPI::ViewerDelegateComponentPluginBase
    • ViewerDelegateComponentPluginBase()
    • ~ViewerDelegateComponentPluginBase()
    • getViewerDelegate()
    • getAttributes()
  • Foundry::Katana::ViewerAPI::ViewerDelegateComponent
    • ViewerDelegateComponent()
    • ~ViewerDelegateComponent()
    • setup()
    • cleanup()
    • locationEvent()
    • usdPrimEvent()
    • locationsSelected()
    • usdPrimsSelected()
    • isProcessing()
    • getPrivateData()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
    • getBounds()
    • computeExtent()
    • flush()
  • Foundry::Katana::ViewerAPI::ViewerDelegateComponentWrapper
    • ViewerDelegateComponentWrapper()
    • ~ViewerDelegateComponentWrapper()
    • getPluginInstance()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
    • getBounds()
    • computeExtent()
• Locators
  • LocatorCreateCallback
  • LocatorMatchesCallback
  • LocatorGetBoundsCallback
  • LocatorComputeExtentCallback
  • OverridesBaseGeometryCallback
  • Foundry::Katana::ViewerUtils::FnBaseLocator
    • Ptr
    • WeakPtr
    • FnBaseLocator()
    • ~FnBaseLocator()
    • setup()
    • cleanup()
    • locationSetup()
    • locationCleanup()
    • draw()
    • pickerDraw()
    • onFrameBegin()
    • onFrameEnd()
    • getViewerDelegateComponent()
    • setViewerDelegateComponent()
    • getViewportLayer()
    • setViewportLayer()
    • getAttribute()
    • isLocationSelected()
    • getDefaultShaderProgram()
    • setDefaultShaderProgram()
  • Foundry::Katana::ViewerUtils::FnBaseLocatorVDC
    • FnBaseLocatorVDC()
    • ~FnBaseLocatorVDC()
    • setup()
    • cleanup()
    • locationEvent()
    • locationsSelected()
    • getPrivateData()
    • getBounds()
    • computeExtent()
    • removeLocation()
    • createSceneNode()
    • dirtyAllViewports()
    • getRootSceneNode()
    • getLocatorLocations()
    • isLocationSelected()
    • isLocationHidden()
    • flush()
    • create()
    • registerLocator()
    • getRegisteredLocators()
  • Foundry::Katana::ViewerUtils::FnBaseLocatorViewportLayer
    • FnBaseLocatorViewportLayer()
    • ~FnBaseLocatorViewportLayer()
    • freeze()
    • thaw()
    • setup()
    • cleanup()
    • draw()
    • pickerDraw()
    • usesPickingOnHover()
    • resize()
    • setOption()
    • initializeLocators()
    • drawLocators()
    • create()
• USD Locators
  • Foundry::Katana::ViewerUtils::SceneNode
    • Ptr
    • WeakPtr
    • SceneNode()
    • SceneNode()
    • SceneNode()
    • operator=()
    • operator=()
    • ~SceneNode()
    • getParentNode()
    • getPath()
    • setLocalXform()
    • getOrComputeWorldXform()
    • setSkipped()
    • isSkipped()
    • setSelected()
    • isSelected()
    • getData()
    • getData()
  • Foundry::Katana::ViewerUtils::Scene
    • Scene()
    • ~Scene()
    • Scene()
    • Scene()
    • operator=()
    • operator=()
    • getRootNode()
    • getNode()
    • getOrCreateNode()
    • removeNode()
  • Foundry::Katana::ViewerUtils::FnUsdBaseLocator
    • Ptr
    • FnUsdBaseLocator()
    • ~FnUsdBaseLocator()
    • FnUsdBaseLocator()
    • FnUsdBaseLocator()
    • operator=()
    • operator=()
    • setup()
    • cleanup()
    • canMatchUnloaded()
    • matches()
    • onFrameBegin()
    • onFrameEnd()
    • preDraw()
    • postDraw()
    • draw()
    • getBounds()
    • getDefaultShader()
    • getViewportLayer()
  • Foundry::Katana::ViewerUtils::FnUsdBaseLocatorVDC
    • ~FnUsdBaseLocatorVDC()
    • FnUsdBaseLocatorVDC()
    • FnUsdBaseLocatorVDC()
    • operator=()
    • operator=()
    • setup()
    • cleanup()
    • locationEvent()
    • locationsSelected()
    • usdPrimEvent()
    • usdPrimsSelected()
    • getBounds()
    • setOption()
    • getDefaultShader()
    • getViewportLayer()
    • create()
    • flush()
    • registerLocator()
  • Foundry::Katana::ViewerUtils::FnUsdBaseLocatorViewportLayer
    • ~FnUsdBaseLocatorViewportLayer()
    • FnUsdBaseLocatorViewportLayer()
    • FnUsdBaseLocatorViewportLayer()
    • operator=()
    • operator=()
    • freeze()
    • thaw()
    • setup()
    • cleanup()
    • draw()
    • pickerDraw()
    • resize()
    • setOption()
    • create()
• Event Wrapper
  • Foundry::Katana::ViewerAPI::FnEventWrapper
    • MouseButtons
      • kNoButton
      • kLeftButton
      • kRightButton
      • kMidButton
      • kMiddleButton
      • kXButton1
      • kXButton2
    • KeyboardModifiers
      • kNoModifier
      • kShiftModifier
      • kControlModifier
      • kAltModifier
      • kMetaModifier
      • kKeypadModifier
      • kGroupSwitchModifier
    • FnEventWrapper()
    • FnEventWrapper()
    • FnEventWrapper()
    • ~FnEventWrapper()
    • getType()
    • getTypeHash()
    • getData()
    • getHandle()
    • getRetainedHandle()
• OpenGL State Helper
  • Bit
    • Enable
    • AccumuBuffer
    • ColorBuffer
    • Current
    • DepthBuffer
    • Eval
    • Fog
    • Hint
    • Lighting
    • Line
    • List
    • Multisample
    • PixelMode
    • Point
    • Polygon
    • PolygonStipple
    • Scissor
    • StencilBuffer
    • Texture
    • Transform
    • Viewport
  • Binding
    • UnbindArrayBuffer
    • UnbindTexture
    • UnbindVertexArray
    • UnbindProgram
    • UnbindAll
  • Foundry::Katana::ViewerUtils::GLStateRestore
    • GLStateRestore()
    • ~GLStateRestore()
• Manipulators
  • ManipulatorWrapperPtr
  • Foundry::Katana::ViewerAPI::ManipulatorPluginBase
    • ManipulatorPluginBase()
    • ~ManipulatorPluginBase()
    • getPluginName()
    • getViewport()
    • getLocationPaths()
    • getXform()
    • setXform()
    • calculateAveragePositionXform()
    • setValue()
    • openManipulationGroup()
    • closeManipulationGroup()
    • getValue()
    • addManipulatorHandle()
    • getManipulatorHandle()
    • getManipulatorHandle()
    • removeManipulatorHandle()
    • removeManipulatorHandle()
    • getNumberOfManipulatorHandles()
    • getManipulatorHandleName()
    • isInteractive()
    • GetRegisteredManipulatorsInfo()
    • kTagName
    • kTagShortcut
    • kTagGroup
    • kTagTechnology
    • kTagAlwaysAvailable
    • kTagExclusiveInGroup
    • kTagPriorityInGroup
    • kTagGroup_TRANSFORM
    • kTagGroup_LIGHT
  • Foundry::Katana::ViewerAPI::Manipulator
    • Manipulator()
    • ~Manipulator()
    • setup()
    • event()
    • draw()
    • pickerDraw()
    • getPrivateData()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
    • matches()
    • getTags()
  • Foundry::Katana::ViewerAPI::ManipulatorWrapper
    • ManipulatorWrapper()
    • ~ManipulatorWrapper()
    • getPluginInstance()
    • matches()
    • getTags()
    • draw()
    • event()
    • pickerDraw()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
• Manipulator Handles
  • ManipulatorHandleWrapperPtr
  • Foundry::Katana::ViewerAPI::ManipulatorHandlePluginBase
    • ManipulatorHandlePluginBase()
    • ~ManipulatorHandlePluginBase()
    • getManipulator()
    • getXform()
    • setLocalXform()
    • getLocalXform()
    • isActive()
    • isHovered()
  • Foundry::Katana::ViewerAPI::ManipulatorHandle
    • ManipulatorHandle()
    • ~ManipulatorHandle()
    • cancelManipulation()
    • draw()
    • pickerDraw()
    • event()
    • getPrivateData()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
  • Foundry::Katana::ViewerAPI::ManipulatorHandleWrapper
    • ManipulatorHandleWrapper()
    • ~ManipulatorHandleWrapper()
    • getPluginInstance()
    • setActive()
    • setHovered()
    • cancelManipulation()
    • draw()
    • event()
    • pickerDraw()
    • setOption()
    • getOption()
    • setOption()
    • getOption()
• Math Types
  • Matrix44f
  • Matrix44d
  • Vec2i
  • Vec2f
  • Vec2d
  • Vec3i
  • Vec3f
  • Vec3d
  • Vec4i
  • Vec4f
  • Vec4d
  • Foundry::Katana::ViewerAPI::Matrix44
    • Matrix44()
    • Matrix44()
    • Matrix44()
    • getData()
  • Foundry::Katana::ViewerAPI::Vec2
    • Vec2()
    • Vec2()
    • operator-()
    • operator+()
    • operator-()
    • dot()
    • length()
    • normalized()
    • isParallelTo()
    • operator*()
    • operator/()
    • x
    • y
  • Foundry::Katana::ViewerAPI::Vec3
    • Vec3()
    • Vec3()
    • operator-()
    • operator+()
    • operator-()
    • dot()
    • length()
    • normalized()
    • cross()
    • isParallelTo()
    • operator*()
    • operator/()
    • x
    • y
    • z
  • Foundry::Katana::ViewerAPI::Vec4
    • Vec4()
    • Vec4()
    • x
    • y
    • z
    • w
• Option ID Generator
  • Foundry::Katana::ViewerAPI::OptionIdGenerator
    • value_type
    • GenerateId()
    • LookUpOptionId()
    • getHandle()
    • getSuite()
    • setSuite()
    • setHost()
• Picking Types
  • FnPickId
  • pickIdToColor()
  • pickIdToColor()
  • pickIdToColor()
  • Foundry::Katana::ViewerAPI::PickedAttrsMap
    • toGroupAttribute()
    • fromGroupAttribute()
• Supported Options
  • Hydra Viewport
    • Supported in setOption()
  • Hydra Scene Viewport Layer
    • Supported in setOption()
  • Hydra Viewer Delegate
    • Supported in setOption()
    • Supported in getOption()