Home

Docs

  • Embed iframe
    • Player SDK
      • Initialization
      • Actions and Selectors
      • Tools and Events
      • Working with the Scene Graph
      • Static Publishing
      • Lifecycle Events
      • Plugins
    • 3D Product Configurators
      • Shopify Application
    • Events
      • nodeenter and nodeleave
      • controllerupdate
    • Tools and Commands
      • Orbit
      • Zoom
      • Node Move
      • Node Rotate
      • Node Scale
    • Demos
      • Simple Rotate
      • Switch Camera
      • Switch Materials
      • Import Scene
      • Import Image
      • Material Library
      • Change Visibility
      • Heirarchy Visibility
      • Custom Annotations
      • Manual Annotations
      • Select Node
      • Clear Scene
      • Widgets
      • Add Node
      • Play Clip
      • Load an Existing Plugin
      • Add Operators
      • Set Material Properties
      • Set Transform Properties
      • Get Bounding Box
      • Setup Pivot
      • Load Template Scene
      • VR Hit Testing
      • VR Teleporting
      • Mouse, Touch and VR Interactions
      • VR Controller Event
      • Mode Change Event
      • Frame Changing
      • Highlight Node
      • Move Node On Plane
      • Move Node On Object
      • Node Manipulate
      • Rotate Object
      • Change Camera Transform
      • Attach Object
      • Move Picture on Object
      • Transform Vertices
      • Custom Color
      • Control Clip Play
      • External Canvas
      • Changing The Progress Bar
      • Snapshot
      • Configurator Control
      • Get PolyMesh Details
      • Configurator Panel
      • Create Explode Clip
      • Wireframe
      • Attach Model
      • Zoom Slider
      • Text Shape
      • Image to Shape
    • CHANGELOG

      Modules

      • animation
        • findAnimation
        • getClips
        • getTime
        • initializeAutoRotate
        • queueAnimation
        • queueClip
        • removeAnimation
        • setTime
        • startPlaying
        • stopPlaying
        • updateAnimationAttrs
      • annotations
        • closeAnnotation
        • openAnnotation
        • useCustomAnnotationFunction
        • useCustomOverlayFunction
      • assets
        • addRoot
        • getImageUrl
        • getUrl
        • importImage
      • commands
        • activateCommand
        • addCommand
        • deactivateCommand
        • removeCommand
        • runCommand
        • setCommandOptions
        • updateCommand
        • updateCommands
      • configuration
        • addProduct
        • applyPreset
        • deleteProduct
        • getAttribute
        • getAttributes
        • getAttributesByType
        • getBOM
        • getConfiguration
        • getEvent
        • getForm
        • getForms
        • getPresets
        • getProduct
        • getProducts
        • getProductTour
        • initConfiguration
        • initConfigurator
        • onChange
        • setConfiguration
        • setProduct
        • initConfigurationAsync
        • initConfiguratorAsync
      • dynamicModules
        • isLoaded
        • load
      • player
        • addTool
        • animateCameraTo
        • createExplode
        • displayThumbnail
        • exitFullscreen
        • filterNodesFromCenter
        • filterNodesFromPosition
        • frameScene
        • getActiveColor
        • getCamera
        • getFullscreenBGColor
        • getHoverColor
        • getThree
        • hideTool
        • isFullscreen
        • isLenticularMode
        • isNormalRenderingMode
        • isVRMode
        • removeTool
        • requestFullscreen
        • resize
        • setActiveColor
        • setCameraRadiusConstraint
        • setFullscreenBGColor
        • setHoverColor
        • setProgressBar
        • showTool
        • toggleFullscreen
        • parseExplodeMode
      • scene
        • addNode
        • addOperator
        • attachModel
        • clone
        • filter
        • find
        • get
        • getAll
        • getNodeBoundingBox
        • getRelativeTransform
        • getScreenPosition
        • getWorldTransform
        • reparent
        • set
        • setAll
      • sceneGraph
        • addNode
        • clone
        • deleteNode
      • sceneIO
        • clearScene
        • fetch
        • fetchAndUse
        • getSceneId
        • loadScene
        • prefetch
        • whenLoaded
      • selection
        • addGhoster
        • createSelectionSet
        • deselectAll
        • getSelectedNodes
        • isSelected
        • lastSelectedNode
        • removeGhoster
        • selectNode
        • setHighlightColor
        • setHighlighting

      Events

      • loaded
      • loading
      • preloaded
      • rendered
      • renderingMode
      • threeinitialized

      Global

      • claraplayer
      • Initialization
      • Actions and Selectors
      • Tools and Events
      • Working with the Scene Graph
      • Static Publishing
      • Lifecycle Events
      • Plugins

      Configuring the Player

      The player javascript can be loaded inside a page for custom interactions. This gives you the full power of the player to modify the scene graph, cameras, animations, annotations and more.

      • How to initialize the player
      • Actions and Selectors
      • Tool interface for custom interactions
      • An introduction to manipulating the scene graph

      Learn the API:

      • scene - The interface to the scene graph.
      • sceneIO - Controls IO for the scene graph: loading and importing.
      • animation - Animation