Logo

CEETRON SDK Suite

  • Home

Getting Started

  • Introduction
    • Terms & Conditions
    • Support
  • Modules
  • Architecture Overview
    • Models
    • Unstruct Grid Module (cee.ug)
    • Constant Unstruct Grid Module (cee.cug)
    • Unstruct Surface Grid Module (cee.usg)
    • Visualization Streamer Module (cee.vs)
    • Geometry Module (cee.geo)
    • Markup Module (cee.mrk)

Examples

  • Build Your First App
  • Examples
    • Example Applications
    • Analyzer Cloud
    • Ceetron Cloud

Programming Guide

  • Distribution Content
  • License
  • Supported File Formats (RemoteModel)
  • Data Provider Plugins (RemoteModel)
  • CAE Model Queries (RemoteModel)
  • Server for Remote Models (UgServer)
    • Getting Started with RemoteModel (Interactive Post Processing of CAE Models)
    • Logging in UgServer
    • Examples
  • Server for Constant Remote Models (CugServer)
    • Getting Started with ConstantRemoteModel (CAE Viewer)
    • Configuring the CugServer
    • Logging in CugServer
  • CugComposer (ConstantRemoteModel)
    • Authoring Models for the Constant Remote Model
      • Overview
      • Using the CugComposer
  • Operators in Envision Web
    • Overview
    • The OperatorStack Class
    • The Operator Class
    • Basic Examples
    • The “Hot Key” Operator
    • Operators Examples and Example App
    • Disabling Operators in Favor of Legacy Viewer UI
    • Transitioning from the Legacy Viewer UI functions to Operators
  • Visualization Streamer
    • Overview
      • Overall design
      • Data Objects
      • Instances
      • Frames
      • Streams
      • gRPC documentation
      • C++ Proxy documentation
    • Getting Started
      • VizStreamer Service
      • Server Application
      • Client-side Model
    • vsp::VizStreamerProxy - C++ Proxy Class
      • Expected and Status
      • Documentation
      • Not Implemented
    • VizStreamerService gRPC
      • Overview
      • RPC Methods
      • Messages
      • Enums
      • Data Types
      • Notes
    • Examples
      • C++/Proxy
        • Configuring the Build
        • Build the Example
        • Running the Example
      • .NET/gRPC
        • Setup and Generate Code from Protos
        • Running the Example
        • Additional Information
      • Node.js/gRPC
        • Setup and Generate Code from Protos
        • Running the Example
        • Additional
      • Python/gRPC
        • Setup and Generate Code from Protos
        • Running the Example
        • Debugging Tips

API References

  • Class Index
    • cee.cug
      • Animation
        • Animation
        • Properties
        • Methods
      • Base64ModelBundle
        • Base64ModelBundle
        • Properties
      • BinaryModelBundle
        • BinaryModelBundle
        • Constructors
        • Methods
      • ConstantRemoteModel
        • ConstantRemoteModel
        • Constructors
        • Accessors
        • Methods
      • CuttingPlane
        • CuttingPlane
        • Accessors
      • DataStreamingCompleteCallback
        • DataStreamingCompleteCallback
      • FrameInfo
        • FrameInfo
        • Accessors
      • HitItem
        • HitItem
        • Properties
      • InitializationCompleteCallback
        • InitializationCompleteCallback
      • InitializationCompleteInfo
        • InitializationCompleteInfo
        • Properties
      • Isosurface
        • Isosurface
        • Accessors
      • Isovolume
        • Isovolume
        • Accessors
      • ModelSpec
        • ModelSpec
        • Accessors
        • Methods
      • ObjectType
        • Enumeration Members
      • OpenModelOptions
        • OpenModelOptions
        • Properties
      • OpenRemoteBundleOptions
        • OpenRemoteBundleOptions
        • Properties
      • Part
        • Part
        • Accessors
      • ParticleTraceGroup
        • ParticleTraceGroup
        • Accessors
      • ProgressData
        • ProgressData
        • Properties
      • ProgressHandler
        • ProgressHandler
      • QueryNodeScalarTimeHistory
        • QueryNodeScalarTimeHistory
        • Constructors
        • Methods
      • QueryNodeScalarTimeHistoryCallback
        • QueryNodeScalarTimeHistoryCallback
      • QueryNodeScalarTimeHistoryData
        • QueryNodeScalarTimeHistoryData
        • Properties
      • RayIntersectCallback
        • RayIntersectCallback
      • RemoteQuery
        • RemoteQuery
      • ResultInfo
        • ResultInfo
        • Accessors
      • ResultMapping
        • Enumeration Members
      • ResultType
        • Enumeration Members
      • ServerItemIdent
        • ServerItemIdent
      • SimulationInfo
        • SimulationInfo
        • Accessors
    • cee.geo
      • CgeoModelGenerator
        • CgeoModelGenerator
        • Constructors
        • Methods
      • GeometryModel
        • GeometryModel
        • Constructors
        • Accessors
        • Methods
      • GeometryModelManipulator
        • GeometryModelManipulator
        • Constructors
        • Methods
      • GeometryModelMockups
        • GeometryModelMockups
        • Constructors
        • Methods
      • GeometryModelRemoteLoader
        • GeometryModelRemoteLoader
        • Constructors
        • Methods
      • HitItem
        • HitItem
        • Properties
      • Mesh
        • Mesh
        • Properties
        • Methods
      • MeshHitItem
        • MeshHitItem
        • Constructors
        • Properties
      • MeshIndexedLines
        • MeshIndexedLines
        • Constructors
        • Accessors
        • Methods
      • MeshIndexedTriangles
        • MeshIndexedTriangles
        • Constructors
        • Accessors
        • Methods
      • MeshPrimitiveType
        • Enumeration Members
      • OptionalIndexedLinesVertexData
        • OptionalIndexedLinesVertexData
        • Properties
      • OptionalIndexedTriangleVertexData
        • OptionalIndexedTriangleVertexData
        • Properties
      • Part
        • Part
        • Accessors
      • PartSettings
        • PartSettings
        • Accessors
      • PolygonOffset
        • Enumeration Members
      • RemoteLoaderCompleteCallback
        • RemoteLoaderCompleteCallback
      • RemoteLoaderInitializationCompleteCallback
        • RemoteLoaderInitializationCompleteCallback
      • RemoteLoaderModelInfo
        • RemoteLoaderModelInfo
        • Properties
      • RemoteLoaderStatusInfo
        • RemoteLoaderStatusInfo
        • Constructors
        • Properties
      • RemoteLoaderTimingInfo
        • RemoteLoaderTimingInfo
        • Constructors
        • Properties
    • cee.mrk
      • CustomDrawOntoCanvasCallback
        • CustomDrawOntoCanvasCallback
      • HitItem
        • HitItem
        • Properties
      • LabelAppearance
        • LabelAppearance
        • Accessors
        • Methods
      • LabelAppearanceProperties
        • LabelAppearanceProperties
        • Properties
      • LabelAttachmentAppearance
        • LabelAttachmentAppearance
        • Accessors
      • LabelAttachmentPoint
        • Enumeration Members
      • LabelAttachmentType
        • Enumeration Members
      • LabelDrawMode
        • Enumeration Members
      • LineTerminatorDrawMode
        • Enumeration Members
      • MarkupModel
        • MarkupModel
        • Constructors
        • Accessors
        • Methods
      • OccluderOptions
        • OccluderOptions
        • Constructors
        • Properties
      • Part
        • Part
        • Accessors
        • Methods
      • PartArrows
        • PartArrows
        • Accessors
        • Methods
      • PartHitItem
        • PartHitItem
        • Constructors
        • Properties
      • PartImageLabel
        • PartImageLabel
        • Accessors
        • Methods
      • PartIndexedTriangles
        • PartIndexedTriangles
        • Accessors
        • Methods
      • PartLabels
        • PartLabels
        • Accessors
        • Methods
      • PartLines
        • PartLines
        • Accessors
        • Methods
      • PartPoints
        • PartPoints
        • Accessors
        • Methods
      • PartTexturedIndexedTriangles
        • PartTexturedIndexedTriangles
        • Accessors
        • Methods
    • cee.ug
      • Animation
        • Animation
        • Accessors
        • Methods
      • AnimationFrameChangedCallback
        • AnimationFrameChangedCallback
      • ApplyVTFxCaseCallback
        • ApplyVTFxCaseCallback
      • AutoRangeMode
        • Enumeration Members
      • Case
        • Case
        • Constructors
        • Methods
      • ClientSideHitItem
        • ClientSideHitItem
        • Accessors
      • ColorScheme
        • Enumeration Members
      • CommunicationPerformanceData
        • CommunicationPerformanceData
        • Properties
      • CommunicationPerformanceHandler
        • CommunicationPerformanceHandler
      • CreateResultCalculatorCallback
        • CreateResultCalculatorCallback
      • CuttingPlane
        • CuttingPlane
        • Accessors
        • Methods
      • CuttingPlaneProperties
        • CuttingPlaneProperties
        • Properties
      • CuttingPlaneUtils
        • CuttingPlaneUtils
        • Constructors
        • Methods
      • DataSourceRequestCallback
        • DataSourceRequestCallback
      • DataSourceResponse
        • DataSourceResponse
        • Properties
      • DataStreamingCompleteCallback
        • DataStreamingCompleteCallback
      • DeriveOperation
        • Enumeration Members
      • DisplacementScaleMode
        • Enumeration Members
      • DisplacementSettings
        • DisplacementSettings
        • Accessors
        • Methods
      • DisplacementSettingsProperties
        • DisplacementSettingsProperties
        • Properties
      • DrawStyle
        • Enumeration Members
      • ElementInterpolationType
        • Enumeration Members
      • FeatureExtractionType
        • Enumeration Members
      • HighlightHelper
        • HighlightHelper
        • Constructors
        • Methods
      • HitItem
        • HitItem
        • Properties
      • Isosurface
        • Isosurface
        • Accessors
        • Methods
      • IsosurfaceProperties
        • IsosurfaceProperties
        • Properties
      • Isovolume
        • Isovolume
        • Accessors
        • Methods
      • IsovolumeProperties
        • IsovolumeProperties
        • Properties
      • ItemType
        • Enumeration Members
      • LegendColorMarker
        • LegendColorMarker
        • Properties
      • LegendColorMarkerPosition
        • Enumeration Members
      • LegendVisibilityMode
        • Enumeration Members
      • MassedParticleParameters
        • MassedParticleParameters
        • Properties
      • MirrorSettings
        • MirrorSettings
        • Accessors
        • Methods
      • MirrorSettingsProperties
        • MirrorSettingsProperties
        • Properties
      • ModelColorSource
        • Enumeration Members
      • ModelDirectory
        • ModelDirectory
        • Properties
        • Methods
      • ModelSettings
        • ModelSettings
        • Accessors
        • Methods
      • ModelSettingsProperties
        • ModelSettingsProperties
        • Properties
      • ModelSpec
        • ModelSpec
        • Accessors
        • Methods
      • ModelSpecProperties
        • ModelSpecProperties
        • Properties
      • ModeShapeAnimationType
        • Enumeration Members
      • NodeIdent
        • NodeIdent
        • Properties
      • ObjectType
        • Enumeration Members
      • OpenModelCallback
        • OpenModelCallback
      • OpenModelCallbackCompletedAction
        • Enumeration Members
      • OpenModelInfo
        • OpenModelInfo
        • Properties
      • OpenModelOptions
        • OpenModelOptions
        • Properties
      • ParticleTraceGroup
        • ParticleTraceGroup
        • Accessors
        • Methods
      • ParticleTraceGroupProperties
        • ParticleTraceGroupProperties
        • Properties
      • ParticleTraceUtils
        • ParticleTraceUtils
        • Constructors
        • Methods
      • ParticleTraceVisualizationStyle
        • Enumeration Members
      • PartInfo
        • PartInfo
        • Properties
      • PartSettings
        • PartSettings
        • Accessors
        • Methods
      • PartSettingsProperties
        • PartSettingsProperties
        • Properties
      • PickHelper
        • PickHelper
        • Constructors
        • Methods
      • PollForDataSourceChangesCallback
        • PollForDataSourceChangesCallback
      • PollForDataSourceChangesInfo
        • PollForDataSourceChangesInfo
        • Properties
      • ProgressData
        • ProgressData
        • Properties
      • ProgressHandler
        • ProgressHandler
      • QueryAllElementResultsForFrame
        • QueryAllElementResultsForFrame
        • Constructors
        • Accessors
        • Methods
      • QueryAllElementResultsForFrameCallback
        • QueryAllElementResultsForFrameCallback
      • QueryAllElementResultsForFrameData
        • QueryAllElementResultsForFrameData
        • Properties
      • QueryAllElementResultsForFramePartData
        • QueryAllElementResultsForFramePartData
        • Properties
      • QueryBulkCalculation
        • QueryBulkCalculation
        • Constructors
        • Accessors
        • Methods
      • QueryBulkCalculationCallback
        • QueryBulkCalculationCallback
      • QueryBulkCalculationValues
        • QueryBulkCalculationValues
        • Properties
      • QueryElementInfo
        • QueryElementInfo
        • Constructors
        • Accessors
        • Methods
      • QueryElementInfoCallback
        • QueryElementInfoCallback
      • QueryElementInfoData
        • QueryElementInfoData
        • Properties
      • QueryFeatureExtraction
        • QueryFeatureExtraction
        • Constructors
        • Methods
      • QueryFeatureExtractionCallback
        • QueryFeatureExtractionCallback
      • QueryFeatureExtractionData
        • QueryFeatureExtractionData
        • Properties
      • QueryFeatureExtractionSurface
        • QueryFeatureExtractionSurface
        • Properties
      • QueryGeometryStatistics
        • QueryGeometryStatistics
        • Constructors
        • Methods
      • QueryGeometryStatisticsCallback
        • QueryGeometryStatisticsCallback
      • QueryGeometryStatisticsData
        • QueryGeometryStatisticsData
        • Properties
      • QueryGlobalNodePositionsForFrames
        • QueryGlobalNodePositionsForFrames
        • Constructors
        • Methods
      • QueryGlobalNodePositionsForFramesCallback
        • QueryGlobalNodePositionsForFramesCallback
      • QueryGlobalNodePositionsForFramesData
        • QueryGlobalNodePositionsForFramesData
        • Properties
      • QueryGlobalNodePositionsForFramesDataItem
        • QueryGlobalNodePositionsForFramesDataItem
        • Properties
      • QueryMapResultOnPoints
        • QueryMapResultOnPoints
        • Constructors
        • Methods
      • QueryMapResultOnPointsData
        • QueryMapResultOnPointsData
        • Properties
      • QueryMapScalarOnPointsCallback
        • QueryMapScalarOnPointsCallback
      • QueryNamedGeneric
        • QueryNamedGeneric
        • Constructors
        • Methods
      • QueryNamedGenericCallback
        • QueryNamedGenericCallback
      • QueryNodeInfo
        • QueryNodeInfo
        • Constructors
        • Accessors
        • Methods
      • QueryNodeInfoCallback
        • QueryNodeInfoCallback
      • QueryNodeInfoData
        • QueryNodeInfoData
        • Properties
      • QueryNodeScalarResult
        • QueryNodeScalarResult
        • Constructors
        • Methods
      • QueryNodeScalarResultCallback
        • QueryNodeScalarResultCallback
      • QueryNodeScalarResultData
        • QueryNodeScalarResultData
        • Properties
      • QueryPartNodes
        • QueryPartNodes
        • Constructors
        • Methods
      • QueryPartNodesCallback
        • QueryPartNodesCallback
      • QueryPartNodesData
        • QueryPartNodesData
        • Properties
      • QueryPartResults
        • QueryPartResults
        • Constructors
        • Methods
      • QueryPartResultsCallback
        • QueryPartResultsCallback
      • QueryPartResultsData
        • QueryPartResultsData
        • Properties
      • QueryPartResultsDataItem
        • QueryPartResultsDataItem
        • Properties
      • QueryPartSurfacePositions
        • QueryPartSurfacePositions
        • Constructors
        • Methods
      • QueryPartSurfacePositionsCallback
        • QueryPartSurfacePositionsCallback
      • QueryPartSurfacePositionsData
        • QueryPartSurfacePositionsData
        • Properties
      • QueryResultMinMax
        • QueryResultMinMax
        • Constructors
        • Accessors
        • Methods
      • QueryResultMinMaxCallback
        • QueryResultMinMaxCallback
      • QueryResultMinMaxData
        • QueryResultMinMaxData
        • Properties
      • QueryResultMinMaxDataItem
        • QueryResultMinMaxDataItem
        • Properties
      • QuerySetItems
        • QuerySetItems
        • Constructors
        • Accessors
        • Methods
      • QuerySetItemsCallback
        • QuerySetItemsCallback
      • QuerySetItemsData
        • QuerySetItemsData
        • Properties
      • QuerySetItemsItem
        • QuerySetItemsItem
        • Properties
      • QuerySurfacePath
        • QuerySurfacePath
        • Constructors
        • Methods
      • QuerySurfacePathCallback
        • QuerySurfacePathCallback
      • QuerySurfacePathData
        • QuerySurfacePathData
        • Properties
      • RayIntersectCallback
        • RayIntersectCallback
      • RayIntersectResult
        • RayIntersectResult
        • Properties
      • ReloadModelCallback
        • ReloadModelCallback
      • RemoteModel
        • RemoteModel
        • Constructors
        • Accessors
        • Methods
      • RemoteQuery
        • RemoteQuery
      • RemoteQueryInputIdentType
        • Enumeration Members
      • ResultCalculatorDefinition
        • ResultCalculatorDefinition
        • Properties
      • ResultInfo
        • ResultInfo
        • Properties
      • ResultMapping
        • Enumeration Members
      • ResultRangeChangedHandler
        • ResultRangeChangedHandler
      • ResultType
        • Enumeration Members
      • ScalarSettings
        • ScalarSettings
        • Accessors
        • Methods
      • ScalarSettingsProperties
        • ScalarSettingsProperties
        • Properties
      • SendToCloudCallback
        • SendToCloudCallback
      • SendToCloudConfig
        • SendToCloudConfig
        • Properties
      • ServerErrorHandler
        • ServerErrorHandler
      • ServerUpdateCompletedCallback
        • ServerUpdateCompletedCallback
      • SetInfo
        • SetInfo
        • Properties
      • SimulationInfo
        • SimulationInfo
        • Properties
      • StateGroupInfo
        • StateGroupInfo
        • Properties
      • StateInfo
        • StateInfo
        • Properties
      • StreamingStatus
        • Enumeration Members
      • SurfacePathItem
        • SurfacePathItem
        • Properties
      • SurfacePathPointType
        • Enumeration Members
      • SurfacePositionType
        • Enumeration Members
      • TrianglePicker
        • TrianglePicker
        • Methods
      • VectorColorMode
        • Enumeration Members
      • VectorDrawMode
        • Enumeration Members
      • VectorScaleMode
        • Enumeration Members
      • VectorSettings
        • VectorSettings
        • Accessors
        • Methods
      • VectorSettingsProperties
        • VectorSettingsProperties
        • Properties
      • VectorType
        • Enumeration Members
      • VisibleObjectItem
        • VisibleObjectItem
        • Properties
      • VisibleObjectPicker
        • VisibleObjectPicker
        • Methods
      • VTFxCaseInfo
        • VTFxCaseInfo
        • Properties
    • cee.usg
      • DisplacementSettings
        • DisplacementSettings
        • Constructors
        • Accessors
      • DrawStyle
        • Enumeration Members
      • ElementHighlighter
        • ElementHighlighter
        • Constructors
        • Methods
      • Geometry
        • Geometry
        • Constructors
        • Accessors
        • Methods
      • HitItem
        • HitItem
        • Properties
      • Mesh
        • Mesh
        • Constructors
        • Accessors
        • Methods
      • MeshQuery
        • MeshQuery
        • Constructors
        • Methods
      • OptionalMeshData
        • OptionalMeshData
        • Properties
      • Part
        • Part
        • Accessors
      • PartDisplacements
        • PartDisplacements
        • Constructors
        • Accessors
      • PartScalars
        • PartScalars
        • Constructors
        • Accessors
        • Methods
      • PartSettings
        • PartSettings
        • Accessors
      • PartVectors
        • PartVectors
        • Constructors
        • Accessors
        • Methods
      • ResultMapping
        • Enumeration Members
      • ScalarSettings
        • ScalarSettings
        • Constructors
        • Accessors
      • ScaleMode
        • Enumeration Members
      • State
        • State
        • Accessors
        • Methods
      • UnstructGridModel
        • UnstructGridModel
        • Constructors
        • Accessors
        • Methods
      • UnstructGridModelOptions
        • UnstructGridModelOptions
        • Properties
      • VectorSettings
        • VectorSettings
        • Constructors
        • Accessors
        • Methods
      • VizStateStrategy
        • Enumeration Members
    • cee.utils
      • AbstractSolidGenerator
        • AbstractSolidGenerator
        • Constructors
        • Properties
        • Methods
      • ArrowGenerator
        • ArrowGenerator
        • Constructors
        • Properties
        • Methods
      • ArrowGeneratorConfig
        • ArrowGeneratorConfig
        • Properties
      • BoxGenerator
        • BoxGenerator
        • Constructors
        • Properties
        • Methods
      • ConeGenerator
        • ConeGenerator
        • Constructors
        • Properties
        • Methods
      • CylinderGenerator
        • CylinderGenerator
        • Constructors
        • Properties
        • Methods
      • CylinderGeneratorConfig
        • CylinderGeneratorConfig
        • Properties
      • ManipulatorTrackball
        • ManipulatorTrackball
        • Constructors
        • Methods
      • PathGenerator
        • PathGenerator
        • Constructors
        • Methods
      • SphereGenerator
        • SphereGenerator
        • Constructors
        • Properties
        • Methods
      • SphereGeneratorConfig
        • SphereGeneratorConfig
        • Properties
    • cee.vs
      • HitItem
        • HitItem
        • Properties
      • ServerSession
        • ServerSession
        • Methods
      • StreamInfo
        • StreamInfo
        • Properties
      • StreamModel
        • StreamModel
        • Accessors
        • Methods
    • AmbientOcclusion
      • AmbientOcclusion
      • Accessors
        • AmbientOcclusion.enable
        • AmbientOcclusion.enable
        • AmbientOcclusion.screenProportionalRadius
        • AmbientOcclusion.screenProportionalRadius
    • AssertFailedHandler
      • AssertFailedHandler
    • Background
      • Background
      • Accessors
        • Background.bottomColor
        • Background.image
        • Background.topColor
      • Methods
        • setImage
        • setSingleColor
        • setTopAndBottomColor
    • BoundingBox
      • BoundingBox
      • Constructors
        • BoundingBox.constructor
      • Properties
        • BoundingBox.maximum
        • BoundingBox.minimum
      • Methods
        • getCenter
        • getExtent
        • isValid
        • static createInvalid
    • Camera
      • Camera
      • Accessors
        • Camera.farPlane
        • Camera.fieldOfViewYDeg
        • Camera.frontPlaneFrustumHeight
        • Camera.nearPlane
        • Camera.projectionType
        • Camera.viewMatrix
        • Camera.viewport
      • Methods
        • applyCameraConfig
        • computeFitViewEyePosition
        • disableAutoClip
        • enableAutoClipFixedNearDistance
        • enableAutoClipMinimumNearDistance
        • fitView
        • fitViewOrtho
        • getDirection
        • getPosition
        • getUp
        • project
        • resetCamera
        • setClipPlanesFromBoundingBox
        • setFromLookAt
        • setProjectionAsOrtho
        • setProjectionAsPerspective
        • setViewChangeHandler
        • setViewMatrix
        • setViewpoint
        • unproject
        • zoomToBoundingBox
    • CameraAnimation
      • CameraAnimation
      • Methods
        • isAbortableByUserNavigation
        • isAnimationDone
        • updateCamera
    • CameraAnimationSpinModel
      • CameraAnimationSpinModel
      • Constructors
        • CameraAnimationSpinModel.constructor
      • Methods
        • isAbortableByUserNavigation
        • isAnimationDone
        • setFullRotationDuration
        • setIsAbortableByUserNavigation
        • setRotationPointAndAxis
        • setTargetFrameRate
        • updateCamera
    • CameraConfig
      • CameraConfig
      • Properties
        • CameraConfig.direction
        • CameraConfig.eye
        • CameraConfig.fieldOfViewYDeg
        • CameraConfig.frontPlaneFrustumHeight
        • CameraConfig.up
    • CameraViewChangeHandler
      • CameraViewChangeHandler
    • ClientCoord
      • ClientCoord
      • Properties
        • ClientCoord.clientX
        • ClientCoord.clientY
    • ClientCoordList
      • ClientCoordList
      • Properties
        • ClientCoordList.length
    • Clipping
      • Clipping
      • Accessors
        • Clipping.planeCount
      • Methods
        • addPlane
        • getGroupId
        • getPlane
        • getPlaneArray
        • removeAllPlanes
        • removePlane
        • setGroupClippingCriteria
        • setPlane
    • ClippingCriteria
      • Enumeration Members
        • BehindAllPlanes
        • BehindOneOrMorePlanes
    • CloudSession
      • CloudSession
      • Constructors
        • CloudSession.constructor
      • Accessors
        • CloudSession.buildDateTimeString
        • CloudSession.version
        • CloudSession.viewerCount
      • Methods
        • addModelToProcessingSet
        • addViewer
        • deleteAllViewers
        • deleteViewerAt
        • destroySession
        • getViewerArray
        • getViewerAt
        • handleAnimationFrameCallback
        • removeModelFromProcessingSet
    • Color3
      • Color3
      • Constructors
        • Color3.constructor
      • Properties
        • Color3.b
        • Color3.g
        • Color3.r
      • Methods
        • equals
        • static from
        • static fromArray
        • static fromColor4
    • Color3Like
      • Color3Like
      • Properties
        • Color3Like.b
        • Color3Like.g
        • Color3Like.r
    • Color4
      • Color4
      • Constructors
        • Color4.constructor
      • Properties
        • Color4.a
        • Color4.b
        • Color4.g
        • Color4.r
      • Methods
        • equals
        • static from
    • Color4Like
      • Color4Like
      • Properties
        • Color4Like.a
        • Color4Like.b
        • Color4Like.g
        • Color4Like.r
    • ColorLegendClickedHandler
      • ColorLegendClickedHandler
    • ColorTable
      • Enumeration Members
        • BLACK_WHITE
        • BLUE_GREEN
        • BLUE_RED
        • COOL_TO_WARM
        • GREEN_YELLOW_RED
        • METAL_CASTING
        • NORMAL
        • RAINBOW
        • RAINBOW_REVERSE
        • RED_YELLOW
        • THERMAL_1
        • THERMAL_2
        • THERMAL_3
        • TURBO
        • VIRIDIS
        • YELLOW_RED
    • ColorTableFactory
      • ColorTableFactory
      • Constructors
        • ColorTableFactory.constructor
      • Methods
        • static color3TableArray
        • static color4TableArray
        • static interpolateColor4Array
        • static interpolateColorArray
        • static partColorArray
    • EyeLift
      • Enumeration Members
        • FACTOR_0_01
        • FACTOR_0_1
        • FACTOR_1
        • OFF
    • HighlightMode
      • Enumeration Members
        • DEPTH_BASED_DIMMING
        • OFF
        • SIMPLE
    • KeyboardModifiers
      • KeyboardModifiers
      • Constructors
        • KeyboardModifiers.constructor
      • Properties
        • KeyboardModifiers.alt
        • KeyboardModifiers.control
        • KeyboardModifiers.meta
        • KeyboardModifiers.shift
    • Logger
      • Logger
      • Constructors
        • Logger.constructor
      • Properties
        • Logger.debug
        • Logger.error
        • Logger.info
        • Logger.warn
      • Methods
        • static enableDebug
        • static enableInfo
    • Mat4
      • Mat4
      • Constructors
        • Mat4.constructor
      • Methods
        • equals
        • getAsArray
        • getInverse
        • getRowCol
        • isIdentity
        • static fromArray
        • static fromCoordSystemAxes
        • static fromElements
        • static fromRotation
        • static fromScaling
        • static fromTranslation
        • static multiply
        • static translatePostMultiply
        • static translatePreMultiply
    • Model
      • Model
      • Constructors
        • Model.constructor
      • Properties
        • Model.name
      • Methods
        • getBoundingBox
        • getDefaultCameraConfig
    • ModelBoundingBoxOptions
      • ModelBoundingBoxOptions
      • Properties
        • ModelBoundingBoxOptions.includeHiddenParts
    • ModelType
      • Enumeration Members
        • Cug
        • Geo
        • Mrk
        • Sg2
        • Ug
        • Usg
        • Vs
    • MouseButtonConfig
      • MouseButtonConfig
      • Properties
        • MouseButtonConfig.ctrlOrCmdModifier
        • MouseButtonConfig.noModifier
        • MouseButtonConfig.shiftModifier
    • MouseNavigationChangedHandler
      • MouseNavigationChangedHandler
    • MouseWheelZoomAndWalkBehavior
      • Enumeration Members
        • IN_OUT_TO_CURSOR
        • IN_TO_CURSOR
        • TO_CENTER
    • Navigation
      • Navigation
      • Constructors
        • Navigation.constructor
      • Accessors
        • Navigation.config
        • Navigation.minWalkTargetDistance
        • Navigation.minWalkTargetDistance
        • Navigation.mouseWheelZoomAndWalkBehavior
        • Navigation.mouseWheelZoomAndWalkBehavior
        • Navigation.rotationPoint
        • Navigation.rotationPoint
        • Navigation.rotationSensitivity
        • Navigation.rotationSensitivity
    • NavigationConfig
      • NavigationConfig
      • Properties
        • NavigationConfig.invertWalkZoom
        • NavigationConfig.invertWheel
        • NavigationConfig.leftAndRightMouseButtons
        • NavigationConfig.leftMouseButton
        • NavigationConfig.middleMouseButton
        • NavigationConfig.oneFinger
        • NavigationConfig.rightMouseButton
        • NavigationConfig.twoFinger
        • NavigationConfig.wheelOrPinch
    • NavigationCubeItem
      • Enumeration Members
        • NCI_ARROW_BOTTOM
        • NCI_ARROW_LEFT
        • NCI_ARROW_RIGHT
        • NCI_ARROW_TOP
        • NCI_CORNER_XN_YN_ZN
        • NCI_CORNER_XN_YN_ZP
        • NCI_CORNER_XN_YP_ZN
        • NCI_CORNER_XN_YP_ZP
        • NCI_CORNER_XP_YN_ZN
        • NCI_CORNER_XP_YN_ZP
        • NCI_CORNER_XP_YP_ZN
        • NCI_CORNER_XP_YP_ZP
        • NCI_EDGE_XN_YN
        • NCI_EDGE_XN_YP
        • NCI_EDGE_XN_ZN
        • NCI_EDGE_XN_ZP
        • NCI_EDGE_XP_YN
        • NCI_EDGE_XP_YP
        • NCI_EDGE_XP_ZN
        • NCI_EDGE_XP_ZP
        • NCI_EDGE_YN_ZN
        • NCI_EDGE_YN_ZP
        • NCI_EDGE_YP_ZN
        • NCI_EDGE_YP_ZP
        • NCI_FACE_X_NEG
        • NCI_FACE_X_POS
        • NCI_FACE_Y_NEG
        • NCI_FACE_Y_POS
        • NCI_FACE_Z_NEG
        • NCI_FACE_Z_POS
        • NCI_HOME
        • NCI_NONE
        • NCI_ROTATE_CCW
        • NCI_ROTATE_CW
    • NavigationCubeViewConfiguration
      • NavigationCubeViewConfiguration
      • Properties
        • NavigationCubeViewConfiguration.direction
        • NavigationCubeViewConfiguration.eye
        • NavigationCubeViewConfiguration.up
    • NavigationMouseButtonConfig
      • NavigationMouseButtonConfig
      • Properties
        • NavigationMouseButtonConfig.ctrlOrCmdModifier
        • NavigationMouseButtonConfig.noModifier
        • NavigationMouseButtonConfig.shiftModifier
    • NavigationOperator
      • NavigationOperator
      • Constructors
        • NavigationOperator.constructor
      • Accessors
        • NavigationOperator.config
        • NavigationOperator.config
        • NavigationOperator.invertWalkZoom
        • NavigationOperator.invertWalkZoom
        • NavigationOperator.minWalkTargetDistance
        • NavigationOperator.minWalkTargetDistance
        • NavigationOperator.mouseWheelZoomAndWalkBehavior
        • NavigationOperator.mouseWheelZoomAndWalkBehavior
        • NavigationOperator.name
        • NavigationOperator.ownerView
        • NavigationOperator.rotationAxis
        • NavigationOperator.rotationAxis
        • NavigationOperator.rotationPoint
        • NavigationOperator.rotationPoint
        • NavigationOperator.rotationSensitivity
        • NavigationOperator.rotationSensitivity
      • Methods
        • onAddedToView
        • onClick
        • onDblClick
        • onKeyDown
        • onKeyUp
        • onMouseDown
        • onMouseMove
        • onMouseUp
        • onPointerDown
        • onPointerMove
        • onPointerUp
        • onRemovedFromView
        • onTouchEnd
        • onTouchMove
        • onTouchStart
        • onWheel
        • resetRotationPoint
    • NavigationType
      • Enumeration Members
        • NONE
        • PAN
        • ROLL
        • ROTATE
        • ROTATE_SCREEN_AXES
        • WALK
        • ZOOM
    • Operator
      • Operator
      • Constructors
        • Operator.constructor
      • Accessors
        • Operator.name
        • Operator.ownerView
      • Methods
        • onAddedToView
        • onClick
        • onDblClick
        • onKeyDown
        • onKeyUp
        • onMouseDown
        • onMouseMove
        • onMouseUp
        • onPointerDown
        • onPointerMove
        • onPointerUp
        • onRemovedFromView
        • onTouchEnd
        • onTouchMove
        • onTouchStart
        • onWheel
    • OperatorConfig
      • OperatorConfig
      • Properties
        • OperatorConfig.invertWheel
        • OperatorConfig.leftAndRightMouseButtons
        • OperatorConfig.leftMouseButton
        • OperatorConfig.middleMouseButton
        • OperatorConfig.oneFinger
        • OperatorConfig.rightMouseButton
        • OperatorConfig.twoFinger
        • OperatorConfig.wheelOrPinch
    • OperatorEventStatus
      • Enumeration Members
        • DO_NOT_PROPAGATE
        • PROPAGATE
    • OperatorStack
      • OperatorStack
      • Accessors
        • OperatorStack.activeOperators
        • OperatorStack.hotKeyOperator
        • OperatorStack.hotKeyOperator
      • Methods
        • clear
        • get
        • has
        • indexOf
        • peek
        • pop
        • push
        • remove
        • set
        • size
    • Overlay
      • Overlay
      • Accessors
        • Overlay.autoAppendModelInfoToInfoBox
        • Overlay.autoAppendModelInfoToInfoBox
        • Overlay.infoBoxPosition
        • Overlay.infoBoxPosition
        • Overlay.infoBoxVisible
        • Overlay.infoBoxVisible
        • Overlay.legendsPosition
        • Overlay.legendsPosition
        • Overlay.maximumLegendHeight
        • Overlay.maximumLegendHeight
        • Overlay.modelColorLegendsVisible
        • Overlay.modelColorLegendsVisible
        • Overlay.navigationCubeHomeDirection
        • Overlay.navigationCubeHomeDirection
        • Overlay.navigationCubeHomeEye
        • Overlay.navigationCubeHomeEye
        • Overlay.navigationCubeHomeUp
        • Overlay.navigationCubeHomeUp
        • Overlay.navigationCubePosition
        • Overlay.navigationCubePosition
        • Overlay.navigationCubeVisible
        • Overlay.navigationCubeVisible
        • Overlay.stepTextVisible
        • Overlay.stepTextVisible
      • Methods
        • addCustomCategoryLegend
        • addCustomColorLegend
        • addCustomColorLegendForScalarMapper
        • configureNavigationCube
        • removeAllCustomLegends
        • setInfoBoxAppearance
        • setInfoBoxContent
        • setStepTextContent
        • viewConfigurationFromNavigationCubeItem
    • OverlayColorLegendContinuousDomain
      • OverlayColorLegendContinuousDomain
      • Constructors
        • OverlayColorLegendContinuousDomain.constructor
      • Accessors
        • OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar
        • OverlayColorLegendContinuousDomain.drawTickMarksOnTopOfLegendBar
        • OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing
        • OverlayColorLegendContinuousDomain.forceUniformTickMarkSpacing
        • OverlayColorLegendContinuousDomain.lineColor
        • OverlayColorLegendContinuousDomain.lineColor
        • OverlayColorLegendContinuousDomain.showTickMarkLabels
        • OverlayColorLegendContinuousDomain.showTickMarkLabels
        • OverlayColorLegendContinuousDomain.textColor
        • OverlayColorLegendContinuousDomain.textColor
        • OverlayColorLegendContinuousDomain.title
        • OverlayColorLegendContinuousDomain.title
      • Methods
        • clearCustomLabels
        • setCustomLabels
        • setTickValues
        • setupFromScalarMapper
    • OverlayItemPosition
      • Enumeration Members
        • BOTTOM_LEFT
        • BOTTOM_RIGHT
        • MIDDLE_LEFT
        • MIDDLE_RIGHT
        • TOP_LEFT
        • TOP_RIGHT
    • PickHandler
      • PickHandler
    • PickHandlerData
      • PickHandlerData
      • Properties
        • PickHandlerData.modifiers
        • PickHandlerData.ray
        • PickHandlerData.view
    • Plane
      • Plane
      • Constructors
        • Plane.constructor
      • Accessors
        • Plane.A
        • Plane.B
        • Plane.C
        • Plane.D
      • Methods
        • equals
        • getDistance
        • getDistanceSquared
        • getNormal
        • getPointInPlane
        • projectPoint
        • projectVector
        • static from
        • static fromPointAndNormal
        • static fromPoints
    • PlaneLike
      • PlaneLike
      • Properties
        • PlaneLike.A
        • PlaneLike.B
        • PlaneLike.C
        • PlaneLike.D
    • ProcessableModel
      • ProcessableModel
    • ProjectionType
      • Enumeration Members
        • ORTHO
        • PERSPECTIVE
    • Range
      • Range
      • Constructors
        • Range.constructor
      • Properties
        • Range.maximum
        • Range.minimum
      • Methods
        • isValid
    • Ray
      • Ray
      • Constructors
        • Ray.constructor
      • Accessors
        • Ray.direction
        • Ray.direction
        • Ray.origin
        • Ray.origin
      • Methods
        • clone
        • planeIntersect
        • pointDistanceSquared
        • transform
    • RaySphereIntersector
      • RaySphereIntersector
      • Constructors
        • RaySphereIntersector.constructor
      • Methods
        • static findAllIntersectedSpheresOrderedByDistanceToRay
        • static findClosestIntersectedSphereToRay
    • ScalarMapper
      • ScalarMapper
      • Methods
        • createTexture
        • mapToColor
        • mapToTextureCoordinate
    • ScalarMapperContinuous
      • ScalarMapperContinuous
      • Constructors
        • ScalarMapperContinuous.constructor
      • Accessors
        • ScalarMapperContinuous.aboveRangeColor
        • ScalarMapperContinuous.aboveRangeColor
        • ScalarMapperContinuous.belowRangeColor
        • ScalarMapperContinuous.belowRangeColor
        • ScalarMapperContinuous.logarithmic
        • ScalarMapperContinuous.rangeMaximum
        • ScalarMapperContinuous.rangeMinimum
        • ScalarMapperContinuous.undefinedColor
        • ScalarMapperContinuous.undefinedColor
      • Methods
        • createTexture
        • domainValue
        • mapToColor
        • mapToTextureCoordinate
        • normalizedValue
        • setColors
        • setColorsAtValues
        • setColorsFromColorTable
        • setRange
        • setRangeLogarithmic
        • tickValuesHint
        • version
    • ScalarMapperContinuousDomain
      • ScalarMapperContinuousDomain
      • Constructors
        • ScalarMapperContinuousDomain.constructor
      • Accessors
        • ScalarMapperContinuousDomain.aboveRangeColor
        • ScalarMapperContinuousDomain.aboveRangeColor
        • ScalarMapperContinuousDomain.belowRangeColor
        • ScalarMapperContinuousDomain.belowRangeColor
        • ScalarMapperContinuousDomain.undefinedColor
        • ScalarMapperContinuousDomain.undefinedColor
      • Methods
        • createTexture
        • domainValue
        • mapToColor
        • mapToTextureCoordinate
        • normalizedValue
        • tickValuesHint
        • version
    • ScalarMapperContinuousPiecewise
      • ScalarMapperContinuousPiecewise
      • Constructors
        • ScalarMapperContinuousPiecewise.constructor
      • Accessors
        • ScalarMapperContinuousPiecewise.aboveRangeColor
        • ScalarMapperContinuousPiecewise.aboveRangeColor
        • ScalarMapperContinuousPiecewise.belowRangeColor
        • ScalarMapperContinuousPiecewise.belowRangeColor
        • ScalarMapperContinuousPiecewise.rangeMaximum
        • ScalarMapperContinuousPiecewise.rangeMinimum
        • ScalarMapperContinuousPiecewise.undefinedColor
        • ScalarMapperContinuousPiecewise.undefinedColor
      • Methods
        • createTexture
        • domainValue
        • mapToColor
        • mapToTextureCoordinate
        • normalizedValue
        • setup
        • tickValuesHint
        • version
    • ScalarMapperFilledContours
      • ScalarMapperFilledContours
      • Constructors
        • ScalarMapperFilledContours.constructor
      • Accessors
        • ScalarMapperFilledContours.aboveRangeColor
        • ScalarMapperFilledContours.aboveRangeColor
        • ScalarMapperFilledContours.belowRangeColor
        • ScalarMapperFilledContours.belowRangeColor
        • ScalarMapperFilledContours.rangeMaximum
        • ScalarMapperFilledContours.rangeMinimum
        • ScalarMapperFilledContours.undefinedColor
        • ScalarMapperFilledContours.undefinedColor
      • Methods
        • createTexture
        • domainValue
        • mapToColor
        • mapToTextureCoordinate
        • normalizedValue
        • setColorsAtValues
        • tickValuesHint
        • version
    • ScalarMapperFilledContoursUniform
      • ScalarMapperFilledContoursUniform
      • Constructors
        • ScalarMapperFilledContoursUniform.constructor
      • Accessors
        • ScalarMapperFilledContoursUniform.aboveRangeColor
        • ScalarMapperFilledContoursUniform.aboveRangeColor
        • ScalarMapperFilledContoursUniform.belowRangeColor
        • ScalarMapperFilledContoursUniform.belowRangeColor
        • ScalarMapperFilledContoursUniform.colorArray
        • ScalarMapperFilledContoursUniform.colorArray
        • ScalarMapperFilledContoursUniform.rangeMaximum
        • ScalarMapperFilledContoursUniform.rangeMinimum
        • ScalarMapperFilledContoursUniform.undefinedColor
        • ScalarMapperFilledContoursUniform.undefinedColor
      • Methods
        • createTexture
        • domainValue
        • mapToColor
        • mapToTextureCoordinate
        • normalizedValue
        • setRange
        • setRangeLogarithmic
        • tickValuesHint
        • version
    • SnapPointPicker
      • SnapPointPicker
      • Constructors
        • SnapPointPicker.constructor
      • Methods
        • findClosestPoint
    • StandardOperator
      • Enumeration Members
        • NAVIGATION
    • Texture
      • Texture
      • Methods
        • static fromHTMLImageElement
        • static fromImageData
    • TextureMagFilter
      • Enumeration Members
        • LINEAR
        • NEAREST
    • TextureMinFilter
      • Enumeration Members
        • LINEAR
        • LINEAR_MIPMAP_LINEAR
        • LINEAR_MIPMAP_NEAREST
        • NEAREST
        • NEAREST_MIPMAP_LINEAR
        • NEAREST_MIPMAP_NEAREST
    • TextureOptions
      • TextureOptions
      • Constructors
        • TextureOptions.constructor
      • Properties
        • TextureOptions.generateMipmaps
        • TextureOptions.magFilter
        • TextureOptions.minFilter
        • TextureOptions.wrapMode
    • TextureWrapMode
      • Enumeration Members
        • CLAMP_TO_EDGE
        • REPEAT
    • Vec2
      • Vec2
      • Constructors
        • Vec2.constructor
      • Properties
        • Vec2.x
        • Vec2.y
      • Methods
        • equals
        • getLength
        • getLengthSquared
        • getNegated
        • getNormalized
        • static add
        • static dot
        • static from
        • static fromArray
        • static negate
        • static scale
        • static sub
    • Vec2Like
      • Vec2Like
      • Properties
        • Vec2Like.x
        • Vec2Like.y
    • Vec3
      • Vec3
      • Constructors
        • Vec3.constructor
      • Properties
        • Vec3.x
        • Vec3.y
        • Vec3.z
      • Methods
        • equals
        • getLength
        • getLengthSquared
        • getNegated
        • getNormalized
        • getPointDistance
        • getPointDistanceSquared
        • static add
        • static cross
        • static dot
        • static from
        • static fromArray
        • static negate
        • static scale
        • static sub
        • static transformPoint
        • static transformVector
    • Vec3Like
      • Vec3Like
      • Properties
        • Vec3Like.x
        • Vec3Like.y
        • Vec3Like.z
    • View
      • View
      • Accessors
        • View.ambientOcclusion
        • View.background
        • View.camera
        • View.clipping
        • View.haloHighlightColor
        • View.haloHighlightColor
        • View.modelCount
        • View.name
        • View.name
        • View.navigation
        • View.nonHighlightedDimFactor
        • View.nonHighlightedDimFactor
        • View.operators
        • View.overlay
        • View.ownerViewer
      • Methods
        • addModel
        • getBoundingBox
        • getIndexOfModel
        • getModelArray
        • getModelAt
        • getRayThroughPoint
        • rayIntersect
        • removeAllModels
        • removeModel
        • removeModelAt
        • requestRedraw
        • setViewport
    • Viewer
      • Viewer
      • Accessors
        • Viewer.disableContextMenu
        • Viewer.disableContextMenu
        • Viewer.pixelScaleFactor
        • Viewer.viewCount
        • Viewer.viewLayoutMode
        • Viewer.viewLayoutMode
      • Methods
        • addView
        • deleteAllViews
        • deleteViewAt
        • enableMouseButtonTracking
        • enableNavigationHandling
        • flyCameraTo
        • getViewArray
        • getViewAt
        • getViewFromCssCoordinate
        • oglWinPosFromClientCoord
        • oglWinPosFromCssCoordinate
        • rayFromCssCoordinate
        • requestRedraw
        • resizeViewer
        • rubberBandZoom
        • setActiveMouseNavigationsChangedHandler
        • setCameraAnimation
        • setColorLegendClickHandler
        • setPickHandler
        • setPixelScaleFactor
        • setShowDebugWindow
    • ViewerOptions
      • ViewerOptions
      • Constructors
        • ViewerOptions.constructor
      • Properties
        • ViewerOptions.alphaChannel
        • ViewerOptions.antiAliasing
        • ViewerOptions.enableTransparencyWBOIT
        • ViewerOptions.forceWebGL1
        • ViewerOptions.globalAmbientIntensity
        • ViewerOptions.globalDefaultSpecularIntensity
        • ViewerOptions.highlightMode
        • ViewerOptions.preserveDrawingBuffer
        • ViewerOptions.useOperators
        • ViewerOptions.wboitMode
    • ViewLayoutMode
      • Enumeration Members
        • Absolute
        • Auto
    • WBOITMode
      • Enumeration Members
        • OPAQUE_DEFAULT_FRAMEBUFFER
        • OPAQUE_OFFSCREEN
    • Functions
      • setAssertFailedHandler
        • setAssertFailedHandler

Additional Resources

  • Release Notes
    • Envision 3.3
      • Fixed Bugs
      • New Features
    • Envision 3.2
      • New Features
    • Envision 3.1
      • Fixed Bugs
      • New Features
    • Envision 3.0
      • Fixed Bugs
      • New Features
      • Breaking Changes
      • Patches
    • Envision 2.4
      • Fixed Bugs
      • New Features
      • Patches
    • Envision 2.3
      • Fixed Bugs
      • New Features
    • Envision 2.2
      • New Features
      • Fixed Bugs
    • Envision 2.1
      • New Features
      • Fixed Bugs
    • Envision 2.0
      • New Features
      • Breaking Changes
    • Envision 1.9
      • New Features
      • Fixed Bugs
      • Patches
    • Envision 1.8
      • New Features
      • Fixed Bugs
      • Patches
    • Envision 1.7
      • New Features
      • Fixed Bugs
      • Patches
    • Envision 1.6
      • New Features
      • Fixed Bugs
    • Envision 1.5
      • New Features
      • Fixed Bugs
    • Envision 1.4
      • New Features
      • Fixed Bugs
    • Envision 1.3
      • New Features
      • Fixed Bugs
      • Patches
    • Envision 1.2
      • New Features
      • Fixed Bugs
      • Patches
    • Envision 1.1
      • New Features
      • Fixed Bugs
    • Envision 1.0
      • New Features
      • Changes
      • Fixed Bugs
  • Acknowledgments
    • Fixed Atlas Font
    • FreeType 2.13.2
    • GLEW
    • gRPC 1.66.2
    • lodepng 20230410
    • Node.js 20.10.1
    • oneTBB 2021.11
    • pugixml 1.14
    • rapidjson
    • Socket.IO 4.7.2
    • ZipArchive 4.6.9
  • Downloads
  • Archives
    • 2025
      • CEETRON Envision for Web
      • CEETRON Envision for Desktop
      • CEETRON Solve/Access/Mesh
    • 2024
      • CEETRON Envision for Web
      • CEETRON Envision for Desktop
      • CEETRON Solve/Access/Mesh
    • 2023
      • CEETRON Envision for Web
      • CEETRON Envision for Desktop
      • CEETRON Solve/Access/Mesh
    • 2022
      • CEETRON Envision for Web
      • CEETRON Envision for Desktop
      • CEETRON Solve/Access/Mesh

Support

  • Developer Support
  • Community Forum
  • Contact Us
CEETRON Envision for Web
  • cee
  • NavigationConfig
Previous Next

NavigationConfig

class cee.NavigationConfig()

Navigation configuration for a view.

Specify how mouse and touch input should be used to navigate the view (move the camera).

Note: To use the right mouse button (either rightMouseButton or leftAndRightMouseButtons), you need to disable the default context menu in the browser (see example below).

Example on how to configure “Ceetron style” navigation:

// Disable context menu - Required for enableMouseButtonTracking
canvas.addEventListener("contextmenu", (event) => { event.preventDefault()});

// Enable mouse tracking (so we can use leftAndRightMouseButtons)
viewer.enableMouseButtonTracking(true);

// Ceetron style navigation
const navConfig = view.navigation.config;
navConfig.leftMouseButton.noModifier =cee.NavigationType.PAN;
navConfig.rightMouseButton.noModifier =cee.NavigationType.ROTATE;
navConfig.leftAndRightMouseButtons.noModifier =cee.NavigationType.WALK;
navConfig.wheelOrPinch = cee.NavigationType.WALK;

Properties

  • invertWalkZoom
  • invertWheel
  • leftAndRightMouseButtons
  • leftMouseButton
  • middleMouseButton
  • oneFinger
  • rightMouseButton
  • twoFinger
  • wheelOrPinch

Properties

NavigationConfig.invertWalkZoom
Type:boolean

Invert zoom or walk. If true, camera will zoom out if mouse is moved up

Default is false

NavigationConfig.invertWheel
Type:boolean

Invert the zoom direction of the mouse wheel

Default is false

NavigationConfig.leftAndRightMouseButtons
Type:NavigationMouseButtonConfig

Navigation config when both left and right mouse buttons are pressed.

Default is NONE for all modifier states.

Note: To use the leftAndRightMouseButtons you have to enable mouse tracking in the viewer. See Viewer.enableMouseButtonTracking. This again requires the browser context menu to be disabled

NavigationConfig.leftMouseButton
Type:NavigationMouseButtonConfig

Navigation config for left mouse button.

Default is

  • no modifiers -> ROTATE
  • shift pressed -> WALK
  • ctrl or cmd pressed -> PAN
NavigationConfig.middleMouseButton
Type:NavigationMouseButtonConfig

Navigation config for middle mouse button.

Default is NONE for all modifier states.

NavigationConfig.oneFinger
Type:NavigationType

Navigation type to use for one finger dragging.

Default is ROTATE

NavigationConfig.rightMouseButton
Type:NavigationMouseButtonConfig

Navigation config for right mouse button.

Default is NONE for all modifier states.

NavigationConfig.twoFinger
Type:NavigationType

Navigation type to use for two finger dragging.

Default is PAN

NavigationConfig.wheelOrPinch
Type:NavigationType

Navigation type to use for mouse wheel/touch screen pinch events.

Default is WALK

Previous Next

© Copyright 2025, Tech Soft 3D

Hello I'm HOOPSY!

HOOPSY BETA

Hello I am HOOPSY! your Docs generative AI assistant.

Ask me anything about CEETRON Envision for Web or choose a sample question below to start a conversation:

Additional info

HOOPSY may store chats to provide and maintain the service according to OpenAI's data policy.


This feature is currently experimental. While we are continually enhancing its performance and quality, the underlying AI model may generate inaccurate or fabricated responses, especially if prompted to do so.

New Conversation

Continue generating
Return to top