.. role:: ts-api-decorator

######
cee.ug
######

.. container:: ts-api-section

   .. js:module:: cee.ug

   The **ug** sub-module provides a remote model designed for post-processing CAE models. 
   It requires a live connection to an EnvisionWeb server.

   The UgServer reads the CAE analysis and streams the triangles needed for the visualization
   to the browser based client using Envision 3D Progressive Object Streaming. Any computation of 
   cutting planes, isosurfaces, isovolumes and particle traces is done on the server, and the
   resulting objects are streamed to the browser client.

   Assuming that the EnvisionWeb client component has been imported into the variable ``cee``, the members of
   the ug module may be referenced using the ``cee.ug`` prefix, e.g.:


   .. code-block:: javascript

      var model = new cee.ug.RemoteModel();



   See the ``RemoteModel`` for a more detailed description of the capabilities of this component.




.. toctree::
   :titlesonly:
   :hidden:

   /c3_reference/classes/cee.ug.Animation
   /c3_reference/interfaces/cee.ug.AnimationFrameChangedCallback
   /c3_reference/interfaces/cee.ug.ApplyVTFxCaseCallback
   /c3_reference/enum/cee.ug.AutoRangeMode
   /c3_reference/classes/cee.ug.Case
   /c3_reference/classes/cee.ug.ClientSideHitItem
   /c3_reference/enum/cee.ug.ColorScheme
   /c3_reference/interfaces/cee.ug.CommunicationPerformanceData
   /c3_reference/interfaces/cee.ug.CommunicationPerformanceHandler
   /c3_reference/interfaces/cee.ug.CreateResultCalculatorCallback
   /c3_reference/interfaces/cee.ug.CreateResultCalculatorConfig
   /c3_reference/classes/cee.ug.CuttingPlane
   /c3_reference/interfaces/cee.ug.CuttingPlaneProperties
   /c3_reference/classes/cee.ug.CuttingPlaneUtils
   /c3_reference/interfaces/cee.ug.DataSourceRequestCallback
   /c3_reference/interfaces/cee.ug.DataSourceResponse
   /c3_reference/interfaces/cee.ug.DataStreamingCompleteCallback
   /c3_reference/enum/cee.ug.DeriveOperation
   /c3_reference/enum/cee.ug.DisplacementScaleMode
   /c3_reference/classes/cee.ug.DisplacementSettings
   /c3_reference/interfaces/cee.ug.DisplacementSettingsProperties
   /c3_reference/enum/cee.ug.DrawStyle
   /c3_reference/enum/cee.ug.ElementInterpolationType
   /c3_reference/enum/cee.ug.FeatureExtractionType
   /c3_reference/classes/cee.ug.HighlightHelper
   /c3_reference/interfaces/cee.ug.HitItem
   /c3_reference/classes/cee.ug.Isosurface
   /c3_reference/interfaces/cee.ug.IsosurfaceProperties
   /c3_reference/classes/cee.ug.Isovolume
   /c3_reference/interfaces/cee.ug.IsovolumeProperties
   /c3_reference/enum/cee.ug.ItemType
   /c3_reference/interfaces/cee.ug.LegendColorMarker
   /c3_reference/enum/cee.ug.LegendColorMarkerPosition
   /c3_reference/enum/cee.ug.LegendVisibilityMode
   /c3_reference/interfaces/cee.ug.MassedParticleParameters
   /c3_reference/classes/cee.ug.MirrorSettings
   /c3_reference/interfaces/cee.ug.MirrorSettingsProperties
   /c3_reference/enum/cee.ug.ModelColorSource
   /c3_reference/classes/cee.ug.ModelDirectory
   /c3_reference/classes/cee.ug.ModelSettings
   /c3_reference/interfaces/cee.ug.ModelSettingsProperties
   /c3_reference/classes/cee.ug.ModelSpec
   /c3_reference/interfaces/cee.ug.ModelSpecProperties
   /c3_reference/enum/cee.ug.ModeShapeAnimationType
   /c3_reference/interfaces/cee.ug.NodeIdent
   /c3_reference/enum/cee.ug.ObjectType
   /c3_reference/interfaces/cee.ug.OpenModelCallback
   /c3_reference/enum/cee.ug.OpenModelCallbackCompletedAction
   /c3_reference/interfaces/cee.ug.OpenModelInfo
   /c3_reference/interfaces/cee.ug.OpenModelOptions
   /c3_reference/classes/cee.ug.ParticleTraceGroup
   /c3_reference/interfaces/cee.ug.ParticleTraceGroupProperties
   /c3_reference/classes/cee.ug.ParticleTraceUtils
   /c3_reference/enum/cee.ug.ParticleTraceVisualizationStyle
   /c3_reference/interfaces/cee.ug.PartInfo
   /c3_reference/classes/cee.ug.PartSettings
   /c3_reference/interfaces/cee.ug.PartSettingsProperties
   /c3_reference/classes/cee.ug.PickHelper
   /c3_reference/interfaces/cee.ug.PollForDataSourceChangesCallback
   /c3_reference/interfaces/cee.ug.PollForDataSourceChangesInfo
   /c3_reference/interfaces/cee.ug.ProgressData
   /c3_reference/interfaces/cee.ug.ProgressHandler
   /c3_reference/classes/cee.ug.QueryAllElementResultsForFrame
   /c3_reference/interfaces/cee.ug.QueryAllElementResultsForFrameCallback
   /c3_reference/interfaces/cee.ug.QueryAllElementResultsForFrameData
   /c3_reference/interfaces/cee.ug.QueryAllElementResultsForFramePartData
   /c3_reference/classes/cee.ug.QueryBulkCalculation
   /c3_reference/interfaces/cee.ug.QueryBulkCalculationCallback
   /c3_reference/interfaces/cee.ug.QueryBulkCalculationValues
   /c3_reference/classes/cee.ug.QueryElementInfo
   /c3_reference/interfaces/cee.ug.QueryElementInfoCallback
   /c3_reference/interfaces/cee.ug.QueryElementInfoData
   /c3_reference/classes/cee.ug.QueryFeatureExtraction
   /c3_reference/interfaces/cee.ug.QueryFeatureExtractionCallback
   /c3_reference/interfaces/cee.ug.QueryFeatureExtractionData
   /c3_reference/interfaces/cee.ug.QueryFeatureExtractionSurface
   /c3_reference/classes/cee.ug.QueryGeometryStatistics
   /c3_reference/interfaces/cee.ug.QueryGeometryStatisticsCallback
   /c3_reference/interfaces/cee.ug.QueryGeometryStatisticsData
   /c3_reference/classes/cee.ug.QueryGlobalNodePositionsForFrames
   /c3_reference/interfaces/cee.ug.QueryGlobalNodePositionsForFramesCallback
   /c3_reference/interfaces/cee.ug.QueryGlobalNodePositionsForFramesData
   /c3_reference/interfaces/cee.ug.QueryGlobalNodePositionsForFramesDataItem
   /c3_reference/classes/cee.ug.QueryMapResultOnPoints
   /c3_reference/interfaces/cee.ug.QueryMapResultOnPointsData
   /c3_reference/interfaces/cee.ug.QueryMapScalarOnPointsCallback
   /c3_reference/classes/cee.ug.QueryNamedGeneric
   /c3_reference/interfaces/cee.ug.QueryNamedGenericCallback
   /c3_reference/classes/cee.ug.QueryNodeInfo
   /c3_reference/interfaces/cee.ug.QueryNodeInfoCallback
   /c3_reference/interfaces/cee.ug.QueryNodeInfoData
   /c3_reference/classes/cee.ug.QueryNodeScalarResult
   /c3_reference/interfaces/cee.ug.QueryNodeScalarResultCallback
   /c3_reference/interfaces/cee.ug.QueryNodeScalarResultData
   /c3_reference/classes/cee.ug.QueryPartNodes
   /c3_reference/interfaces/cee.ug.QueryPartNodesCallback
   /c3_reference/interfaces/cee.ug.QueryPartNodesData
   /c3_reference/classes/cee.ug.QueryPartResults
   /c3_reference/interfaces/cee.ug.QueryPartResultsCallback
   /c3_reference/interfaces/cee.ug.QueryPartResultsData
   /c3_reference/interfaces/cee.ug.QueryPartResultsDataItem
   /c3_reference/classes/cee.ug.QueryPartSurfacePositions
   /c3_reference/interfaces/cee.ug.QueryPartSurfacePositionsCallback
   /c3_reference/interfaces/cee.ug.QueryPartSurfacePositionsData
   /c3_reference/classes/cee.ug.QueryResultMinMax
   /c3_reference/interfaces/cee.ug.QueryResultMinMaxCallback
   /c3_reference/interfaces/cee.ug.QueryResultMinMaxData
   /c3_reference/interfaces/cee.ug.QueryResultMinMaxDataItem
   /c3_reference/classes/cee.ug.QuerySetItems
   /c3_reference/interfaces/cee.ug.QuerySetItemsCallback
   /c3_reference/interfaces/cee.ug.QuerySetItemsData
   /c3_reference/interfaces/cee.ug.QuerySetItemsItem
   /c3_reference/classes/cee.ug.QuerySurfacePath
   /c3_reference/interfaces/cee.ug.QuerySurfacePathCallback
   /c3_reference/interfaces/cee.ug.QuerySurfacePathData
   /c3_reference/interfaces/cee.ug.RayIntersectCallback
   /c3_reference/interfaces/cee.ug.RayIntersectResult
   /c3_reference/interfaces/cee.ug.ReloadModelCallback
   /c3_reference/classes/cee.ug.RemoteModel
   /c3_reference/classes/cee.ug.RemoteQuery
   /c3_reference/enum/cee.ug.RemoteQueryInputIdentType
   /c3_reference/interfaces/cee.ug.ResultCalculatorDefinition
   /c3_reference/interfaces/cee.ug.ResultInfo
   /c3_reference/enum/cee.ug.ResultMapping
   /c3_reference/interfaces/cee.ug.ResultRangeChangedHandler
   /c3_reference/enum/cee.ug.ResultType
   /c3_reference/classes/cee.ug.ScalarSettings
   /c3_reference/interfaces/cee.ug.ScalarSettingsProperties
   /c3_reference/interfaces/cee.ug.SendToCloudCallback
   /c3_reference/interfaces/cee.ug.SendToCloudConfig
   /c3_reference/interfaces/cee.ug.ServerErrorHandler
   /c3_reference/interfaces/cee.ug.ServerUpdateCompletedCallback
   /c3_reference/interfaces/cee.ug.SetInfo
   /c3_reference/interfaces/cee.ug.SimulationInfo
   /c3_reference/interfaces/cee.ug.StateGroupInfo
   /c3_reference/interfaces/cee.ug.StateInfo
   /c3_reference/enum/cee.ug.StreamingStatus
   /c3_reference/interfaces/cee.ug.SurfacePathItem
   /c3_reference/enum/cee.ug.SurfacePathPointType
   /c3_reference/enum/cee.ug.SurfacePositionType
   /c3_reference/classes/cee.ug.TrianglePicker
   /c3_reference/enum/cee.ug.VectorColorMode
   /c3_reference/enum/cee.ug.VectorDrawMode
   /c3_reference/enum/cee.ug.VectorScaleMode
   /c3_reference/classes/cee.ug.VectorSettings
   /c3_reference/interfaces/cee.ug.VectorSettingsProperties
   /c3_reference/enum/cee.ug.VectorType
   /c3_reference/interfaces/cee.ug.VisibleObjectItem
   /c3_reference/classes/cee.ug.VisibleObjectPicker
   /c3_reference/interfaces/cee.ug.VTFxCaseInfo

.. container:: api-index-section

   .. rubric:: Enumerations

   .. rst-class:: api-index-list-item api-kind-enum api-parent-kind-module

   * :ref:`cee.ug.AutoRangeMode`
   * :ref:`cee.ug.ColorScheme`
   * :ref:`cee.ug.DeriveOperation`
   * :ref:`cee.ug.DisplacementScaleMode`
   * :ref:`cee.ug.DrawStyle`
   * :ref:`cee.ug.ElementInterpolationType`
   * :ref:`cee.ug.FeatureExtractionType`
   * :ref:`cee.ug.ItemType`
   * :ref:`cee.ug.LegendColorMarkerPosition`
   * :ref:`cee.ug.LegendVisibilityMode`
   * :ref:`cee.ug.ModeShapeAnimationType`
   * :ref:`cee.ug.ModelColorSource`
   * :ref:`cee.ug.ObjectType`
   * :ref:`cee.ug.OpenModelCallbackCompletedAction`
   * :ref:`cee.ug.ParticleTraceVisualizationStyle`
   * :ref:`cee.ug.RemoteQueryInputIdentType`
   * :ref:`cee.ug.ResultMapping`
   * :ref:`cee.ug.ResultType`
   * :ref:`cee.ug.StreamingStatus`
   * :ref:`cee.ug.SurfacePathPointType`
   * :ref:`cee.ug.SurfacePositionType`
   * :ref:`cee.ug.VectorColorMode`
   * :ref:`cee.ug.VectorDrawMode`
   * :ref:`cee.ug.VectorScaleMode`
   * :ref:`cee.ug.VectorType`



.. container:: api-index-section

   .. rubric:: Classes

   .. rst-class:: api-index-list-item api-kind-class api-parent-kind-module

   * :js:class:`~cee.ug.Animation`
   * :js:class:`~cee.ug.Case`
   * :js:class:`~cee.ug.ClientSideHitItem`
   * :js:class:`~cee.ug.CuttingPlane`
   * :js:class:`~cee.ug.CuttingPlaneUtils`
   * :js:class:`~cee.ug.DisplacementSettings`
   * :js:class:`~cee.ug.HighlightHelper`
   * :js:class:`~cee.ug.Isosurface`
   * :js:class:`~cee.ug.Isovolume`
   * :js:class:`~cee.ug.MirrorSettings`
   * :js:class:`~cee.ug.ModelDirectory`
   * :js:class:`~cee.ug.ModelSettings`
   * :js:class:`~cee.ug.ModelSpec`
   * :js:class:`~cee.ug.PartSettings`
   * :js:class:`~cee.ug.ParticleTraceGroup`
   * :js:class:`~cee.ug.ParticleTraceUtils`
   * :js:class:`~cee.ug.PickHelper`
   * :js:class:`~cee.ug.QueryAllElementResultsForFrame`
   * :js:class:`~cee.ug.QueryBulkCalculation`
   * :js:class:`~cee.ug.QueryElementInfo`
   * :js:class:`~cee.ug.QueryFeatureExtraction`
   * :js:class:`~cee.ug.QueryGeometryStatistics`
   * :js:class:`~cee.ug.QueryGlobalNodePositionsForFrames`
   * :js:class:`~cee.ug.QueryMapResultOnPoints`
   * :js:class:`~cee.ug.QueryNamedGeneric`
   * :js:class:`~cee.ug.QueryNodeInfo`
   * :js:class:`~cee.ug.QueryNodeScalarResult`
   * :js:class:`~cee.ug.QueryPartNodes`
   * :js:class:`~cee.ug.QueryPartResults`
   * :js:class:`~cee.ug.QueryPartSurfacePositions`
   * :js:class:`~cee.ug.QueryResultMinMax`
   * :js:class:`~cee.ug.QuerySetItems`
   * :js:class:`~cee.ug.QuerySurfacePath`
   * :js:class:`~cee.ug.RemoteModel`
   * :js:class:`~cee.ug.RemoteQuery`
   * :js:class:`~cee.ug.ScalarSettings`
   * :js:class:`~cee.ug.TrianglePicker`
   * :js:class:`~cee.ug.VectorSettings`
   * :js:class:`~cee.ug.VisibleObjectPicker`



.. container:: api-index-section

   .. rubric:: Interfaces

   .. rst-class:: api-index-list-item api-kind-interface api-parent-kind-module

   * :js:class:`~cee.ug.AnimationFrameChangedCallback`
   * :js:class:`~cee.ug.ApplyVTFxCaseCallback`
   * :js:class:`~cee.ug.CommunicationPerformanceData`
   * :js:class:`~cee.ug.CommunicationPerformanceHandler`
   * :js:class:`~cee.ug.CreateResultCalculatorCallback`
   * :js:class:`~cee.ug.CreateResultCalculatorConfig`
   * :js:class:`~cee.ug.CuttingPlaneProperties`
   * :js:class:`~cee.ug.DataSourceRequestCallback`
   * :js:class:`~cee.ug.DataSourceResponse`
   * :js:class:`~cee.ug.DataStreamingCompleteCallback`
   * :js:class:`~cee.ug.DisplacementSettingsProperties`
   * :js:class:`~cee.ug.HitItem`
   * :js:class:`~cee.ug.IsosurfaceProperties`
   * :js:class:`~cee.ug.IsovolumeProperties`
   * :js:class:`~cee.ug.LegendColorMarker`
   * :js:class:`~cee.ug.MassedParticleParameters`
   * :js:class:`~cee.ug.MirrorSettingsProperties`
   * :js:class:`~cee.ug.ModelSettingsProperties`
   * :js:class:`~cee.ug.ModelSpecProperties`
   * :js:class:`~cee.ug.NodeIdent`
   * :js:class:`~cee.ug.OpenModelCallback`
   * :js:class:`~cee.ug.OpenModelInfo`
   * :js:class:`~cee.ug.OpenModelOptions`
   * :js:class:`~cee.ug.PartInfo`
   * :js:class:`~cee.ug.PartSettingsProperties`
   * :js:class:`~cee.ug.ParticleTraceGroupProperties`
   * :js:class:`~cee.ug.PollForDataSourceChangesCallback`
   * :js:class:`~cee.ug.PollForDataSourceChangesInfo`
   * :js:class:`~cee.ug.ProgressData`
   * :js:class:`~cee.ug.ProgressHandler`
   * :js:class:`~cee.ug.QueryAllElementResultsForFrameCallback`
   * :js:class:`~cee.ug.QueryAllElementResultsForFrameData`
   * :js:class:`~cee.ug.QueryAllElementResultsForFramePartData`
   * :js:class:`~cee.ug.QueryBulkCalculationCallback`
   * :js:class:`~cee.ug.QueryBulkCalculationValues`
   * :js:class:`~cee.ug.QueryElementInfoCallback`
   * :js:class:`~cee.ug.QueryElementInfoData`
   * :js:class:`~cee.ug.QueryFeatureExtractionCallback`
   * :js:class:`~cee.ug.QueryFeatureExtractionData`
   * :js:class:`~cee.ug.QueryFeatureExtractionSurface`
   * :js:class:`~cee.ug.QueryGeometryStatisticsCallback`
   * :js:class:`~cee.ug.QueryGeometryStatisticsData`
   * :js:class:`~cee.ug.QueryGlobalNodePositionsForFramesCallback`
   * :js:class:`~cee.ug.QueryGlobalNodePositionsForFramesData`
   * :js:class:`~cee.ug.QueryGlobalNodePositionsForFramesDataItem`
   * :js:class:`~cee.ug.QueryMapResultOnPointsData`
   * :js:class:`~cee.ug.QueryMapScalarOnPointsCallback`
   * :js:class:`~cee.ug.QueryNamedGenericCallback`
   * :js:class:`~cee.ug.QueryNodeInfoCallback`
   * :js:class:`~cee.ug.QueryNodeInfoData`
   * :js:class:`~cee.ug.QueryNodeScalarResultCallback`
   * :js:class:`~cee.ug.QueryNodeScalarResultData`
   * :js:class:`~cee.ug.QueryPartNodesCallback`
   * :js:class:`~cee.ug.QueryPartNodesData`
   * :js:class:`~cee.ug.QueryPartResultsCallback`
   * :js:class:`~cee.ug.QueryPartResultsData`
   * :js:class:`~cee.ug.QueryPartResultsDataItem`
   * :js:class:`~cee.ug.QueryPartSurfacePositionsCallback`
   * :js:class:`~cee.ug.QueryPartSurfacePositionsData`
   * :js:class:`~cee.ug.QueryResultMinMaxCallback`
   * :js:class:`~cee.ug.QueryResultMinMaxData`
   * :js:class:`~cee.ug.QueryResultMinMaxDataItem`
   * :js:class:`~cee.ug.QuerySetItemsCallback`
   * :js:class:`~cee.ug.QuerySetItemsData`
   * :js:class:`~cee.ug.QuerySetItemsItem`
   * :js:class:`~cee.ug.QuerySurfacePathCallback`
   * :js:class:`~cee.ug.QuerySurfacePathData`
   * :js:class:`~cee.ug.RayIntersectCallback`
   * :js:class:`~cee.ug.RayIntersectResult`
   * :js:class:`~cee.ug.ReloadModelCallback`
   * :js:class:`~cee.ug.ResultCalculatorDefinition`
   * :js:class:`~cee.ug.ResultInfo`
   * :js:class:`~cee.ug.ResultRangeChangedHandler`
   * :js:class:`~cee.ug.ScalarSettingsProperties`
   * :js:class:`~cee.ug.SendToCloudCallback`
   * :js:class:`~cee.ug.SendToCloudConfig`
   * :js:class:`~cee.ug.ServerErrorHandler`
   * :js:class:`~cee.ug.ServerUpdateCompletedCallback`
   * :js:class:`~cee.ug.SetInfo`
   * :js:class:`~cee.ug.SimulationInfo`
   * :js:class:`~cee.ug.StateGroupInfo`
   * :js:class:`~cee.ug.StateInfo`
   * :js:class:`~cee.ug.SurfacePathItem`
   * :js:class:`~cee.ug.VTFxCaseInfo`
   * :js:class:`~cee.ug.VectorSettingsProperties`
   * :js:class:`~cee.ug.VisibleObjectItem`



