
##
ug
##

.. 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 :js:class:`RemoteModel <cee.ug.RemoteModel>` for a more detailed description of the capabilities of this component.
   



.. rst-class:: kind-group kind-enumerations

.. rubric:: Enumerations
   :class: kind-group-title


.. rst-class:: api-xref-list


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

.. rst-class:: kind-group kind-classes

.. rubric:: Classes
   :class: kind-group-title


.. rst-class:: api-xref-list


* :js:class:`~cee.ug.Animation`
* :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.ParticleTraceGroup`
* :js:class:`~cee.ug.ParticleTraceUtils`
* :js:class:`~cee.ug.PartSettings`
* :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.QuerySurfaceGroup`
* :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`

.. rst-class:: kind-group kind-interfaces

.. rubric:: Interfaces
   :class: kind-group-title


.. rst-class:: api-xref-list


* :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.FileInfo`
* :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.ParticleTraceGroupProperties`
* :js:class:`~cee.ug.PartInfo`
* :js:class:`~cee.ug.PartSettingsProperties`
* :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.QuerySurfaceGroupAvailableSurfaceGroupIdsCallback`
* :js:class:`~cee.ug.QuerySurfaceGroupIdForElementCallback`
* :js:class:`~cee.ug.QuerySurfaceGroupTriangulationCallback`
* :js:class:`~cee.ug.QuerySurfaceGroupTriangulationData`
* :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.VectorSettingsProperties`
* :js:class:`~cee.ug.VisibleObjectItem`
* :js:class:`~cee.ug.VTFxCaseInfo`

.. toctree::
   :maxdepth: 1
   :hidden:

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


