.. role:: ts-api-decorator

###
cee
###

.. container:: ts-api-section

   .. js:module:: cee

   This is the root of the of the EnvisionWeb client component.

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


   .. code-block:: javascript

      var myVec = new cee.Vec3(0,0,1);
      var mySession = new cee.CloudSession();



   The global component contains general classes like Viewer, View, Model, Overlay, etc. It also has all the base classes like Color3, Color4, Vec3, Mat4, Ray.

   The following sub-modules exist:

   - **Remote Model** (:doc:`cee.ug`): Remote Model supporting a full post processing session with a model on a remote server. The CAE model with its results is kept on the 
     server and only the data needed for displaying the model is progressively streamed to the client. Handles FEA and CFD models, and has features like isovolumes, particle traces, 
     cutting planes (all computed on the server). 

   - **Constant Remote Model** (:doc:`cee.cug`):  Efficient and scalable streaming of pre-defined CAE model configurations. The server is a stateless REST API based server 
     with very low resource usage and is easy to load balance. The streaming starts immediately when a model is opened, no matter the size of the model. Like the RemoteModel, data is 
     sent to the client using 3D Progressive Object Streaming. The model needs to be converted to the CUG database format (using the included CugComposer command line utility) before 
     it can be streamed. 

   - **Unstruct Surface Grid** (:doc:`cee.usg`):  Client side (in browser) FEA model for surface elements. Suited for streaming/monitoring as well as transient animations with very fast updates. 
     Supports all result mappings (per node, per element, per element node), all result types (scalars, vectors, displacements and rigid body transformations), 
     all draw styles (surface, surface mesh, outline, lines, points), multiple states, adaptive geometries. Supports any number of nodes per element.

   - **Stream Model** (:doc:`cee.vs`):  Client side (in browser) streaming model designed to work in pair with the Visualization Streamer Service (VizService) to which it requires a live connection. 
     It handles fast and efficient streaming of 3D data to web while being specifically tailored towards showing CAE visualizations. 

   - **Geometry** (:doc:`cee.geo`):  Client side (in browser) geometry model capable of handling a very large number of parts (300k+) with very fast updates when changing part settings.

   - **Markup** (:doc:`cee.mrk`):  Markup model with support for rendering labels and more simple geometry. Useful for creating annotations and other markup of the 3d model.

   - **Utilities** (``cee.utils``): Various helper classes for the components above.




.. toctree::
   :titlesonly:
   :hidden:

   /c3_reference/modules/cee.cug
   /c3_reference/modules/cee.geo
   /c3_reference/modules/cee.mrk
   /c3_reference/modules/cee.ug
   /c3_reference/modules/cee.usg
   /c3_reference/modules/cee.utils
   /c3_reference/modules/cee.vs
   /c3_reference/classes/cee.AmbientOcclusion
   /c3_reference/interfaces/cee.AssertFailedHandler
   /c3_reference/classes/cee.Background
   /c3_reference/classes/cee.BoundingBox
   /c3_reference/classes/cee.Camera
   /c3_reference/interfaces/cee.CameraAnimation
   /c3_reference/classes/cee.CameraAnimationSpinModel
   /c3_reference/interfaces/cee.CameraConfig
   /c3_reference/interfaces/cee.CameraViewChangeHandler
   /c3_reference/interfaces/cee.ClientCoord
   /c3_reference/interfaces/cee.ClientCoordList
   /c3_reference/classes/cee.Clipping
   /c3_reference/enum/cee.ClippingCriteria
   /c3_reference/classes/cee.CloudSession
   /c3_reference/classes/cee.Color3
   /c3_reference/interfaces/cee.Color3Like
   /c3_reference/classes/cee.Color4
   /c3_reference/interfaces/cee.Color4Like
   /c3_reference/interfaces/cee.ColorLegendClickedHandler
   /c3_reference/enum/cee.ColorTable
   /c3_reference/classes/cee.ColorTableFactory
   /c3_reference/enum/cee.EyeLift
   /c3_reference/enum/cee.HighlightMode
   /c3_reference/classes/cee.KeyboardModifiers
   /c3_reference/classes/cee.Logger
   /c3_reference/classes/cee.Mat4
   /c3_reference/classes/cee.Model
   /c3_reference/interfaces/cee.ModelBoundingBoxOptions
   /c3_reference/enum/cee.ModelType
   /c3_reference/interfaces/cee.MouseButtonConfig
   /c3_reference/interfaces/cee.MouseNavigationChangedHandler
   /c3_reference/enum/cee.MouseWheelZoomAndWalkBehavior
   /c3_reference/classes/cee.Navigation
   /c3_reference/interfaces/cee.NavigationConfig
   /c3_reference/enum/cee.NavigationCubeItem
   /c3_reference/interfaces/cee.NavigationCubeViewConfiguration
   /c3_reference/interfaces/cee.NavigationMouseButtonConfig
   /c3_reference/classes/cee.NavigationOperator
   /c3_reference/enum/cee.NavigationType
   /c3_reference/classes/cee.Operator
   /c3_reference/interfaces/cee.OperatorConfig
   /c3_reference/enum/cee.OperatorEventStatus
   /c3_reference/classes/cee.OperatorStack
   /c3_reference/classes/cee.Overlay
   /c3_reference/classes/cee.OverlayColorLegendContinuousDomain
   /c3_reference/enum/cee.OverlayItemPosition
   /c3_reference/interfaces/cee.PickHandler
   /c3_reference/interfaces/cee.PickHandlerData
   /c3_reference/classes/cee.Plane
   /c3_reference/interfaces/cee.PlaneLike
   /c3_reference/interfaces/cee.ProcessableModel
   /c3_reference/enum/cee.ProjectionType
   /c3_reference/classes/cee.Range
   /c3_reference/classes/cee.Ray
   /c3_reference/classes/cee.RaySphereIntersector
   /c3_reference/interfaces/cee.ScalarMapper
   /c3_reference/classes/cee.ScalarMapperContinuous
   /c3_reference/classes/cee.ScalarMapperContinuousDomain
   /c3_reference/classes/cee.ScalarMapperContinuousPiecewise
   /c3_reference/classes/cee.ScalarMapperFilledContours
   /c3_reference/classes/cee.ScalarMapperFilledContoursUniform
   /c3_reference/classes/cee.SnapPointPicker
   /c3_reference/enum/cee.StandardOperator
   /c3_reference/classes/cee.Texture
   /c3_reference/enum/cee.TextureMagFilter
   /c3_reference/enum/cee.TextureMinFilter
   /c3_reference/classes/cee.TextureOptions
   /c3_reference/enum/cee.TextureWrapMode
   /c3_reference/classes/cee.Vec2
   /c3_reference/interfaces/cee.Vec2Like
   /c3_reference/classes/cee.Vec3
   /c3_reference/interfaces/cee.Vec3Like
   /c3_reference/classes/cee.View
   /c3_reference/classes/cee.Viewer
   /c3_reference/classes/cee.ViewerOptions
   /c3_reference/enum/cee.ViewLayoutMode
   /c3_reference/enum/cee.WBOITMode

.. container:: api-index-section

   .. rubric:: Enumerations

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

   * :ref:`cee.ClippingCriteria`
   * :ref:`cee.ColorTable`
   * :ref:`cee.EyeLift`
   * :ref:`cee.HighlightMode`
   * :ref:`cee.ModelType`
   * :ref:`cee.MouseWheelZoomAndWalkBehavior`
   * :ref:`cee.NavigationCubeItem`
   * :ref:`cee.NavigationType`
   * :ref:`cee.OperatorEventStatus`
   * :ref:`cee.OverlayItemPosition`
   * :ref:`cee.ProjectionType`
   * :ref:`cee.StandardOperator`
   * :ref:`cee.TextureMagFilter`
   * :ref:`cee.TextureMinFilter`
   * :ref:`cee.TextureWrapMode`
   * :ref:`cee.ViewLayoutMode`
   * :ref:`cee.WBOITMode`



.. container:: api-index-section

   .. rubric:: Classes

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

   * :js:class:`~cee.AmbientOcclusion`
   * :js:class:`~cee.Background`
   * :js:class:`~cee.BoundingBox`
   * :js:class:`~cee.Camera`
   * :js:class:`~cee.CameraAnimationSpinModel`
   * :js:class:`~cee.Clipping`
   * :js:class:`~cee.CloudSession`
   * :js:class:`~cee.Color3`
   * :js:class:`~cee.Color4`
   * :js:class:`~cee.ColorTableFactory`
   * :js:class:`~cee.KeyboardModifiers`
   * :js:class:`~cee.Logger`
   * :js:class:`~cee.Mat4`
   * :js:class:`~cee.Model`
   * :js:class:`~cee.Navigation`
   * :js:class:`~cee.NavigationOperator`
   * :js:class:`~cee.Operator`
   * :js:class:`~cee.OperatorStack`
   * :js:class:`~cee.Overlay`
   * :js:class:`~cee.OverlayColorLegendContinuousDomain`
   * :js:class:`~cee.Plane`
   * :js:class:`~cee.Range`
   * :js:class:`~cee.Ray`
   * :js:class:`~cee.RaySphereIntersector`
   * :js:class:`~cee.ScalarMapperContinuous`
   * :js:class:`~cee.ScalarMapperContinuousDomain`
   * :js:class:`~cee.ScalarMapperContinuousPiecewise`
   * :js:class:`~cee.ScalarMapperFilledContours`
   * :js:class:`~cee.ScalarMapperFilledContoursUniform`
   * :js:class:`~cee.SnapPointPicker`
   * :js:class:`~cee.Texture`
   * :js:class:`~cee.TextureOptions`
   * :js:class:`~cee.Vec2`
   * :js:class:`~cee.Vec3`
   * :js:class:`~cee.View`
   * :js:class:`~cee.Viewer`
   * :js:class:`~cee.ViewerOptions`



.. container:: api-index-section

   .. rubric:: Interfaces

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

   * :js:class:`~cee.AssertFailedHandler`
   * :js:class:`~cee.CameraAnimation`
   * :js:class:`~cee.CameraConfig`
   * :js:class:`~cee.CameraViewChangeHandler`
   * :js:class:`~cee.ClientCoord`
   * :js:class:`~cee.ClientCoordList`
   * :js:class:`~cee.Color3Like`
   * :js:class:`~cee.Color4Like`
   * :js:class:`~cee.ColorLegendClickedHandler`
   * :js:class:`~cee.ModelBoundingBoxOptions`
   * :js:class:`~cee.MouseButtonConfig`
   * :js:class:`~cee.MouseNavigationChangedHandler`
   * :js:class:`~cee.NavigationConfig`
   * :js:class:`~cee.NavigationCubeViewConfiguration`
   * :js:class:`~cee.NavigationMouseButtonConfig`
   * :js:class:`~cee.OperatorConfig`
   * :js:class:`~cee.PickHandler`
   * :js:class:`~cee.PickHandlerData`
   * :js:class:`~cee.PlaneLike`
   * :js:class:`~cee.ProcessableModel`
   * :js:class:`~cee.ScalarMapper`
   * :js:class:`~cee.Vec2Like`
   * :js:class:`~cee.Vec3Like`



.. container:: api-index-section

   .. rubric:: Functions

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

   * :js:func:`~cee.setAssertFailedHandler`



.. container:: api-index-section

   .. rubric:: Modules

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

   * :js:mod:`~cee.cug`
   * :js:mod:`~cee.geo`
   * :js:mod:`~cee.mrk`
   * :js:mod:`~cee.ug`
   * :js:mod:`~cee.usg`
   * :js:mod:`~cee.utils`
   * :js:mod:`~cee.vs`





------------

Functions
=========

.. rst-class:: ts-api-section

setAssertFailedHandler
----------------------

.. js:function:: setAssertFailedHandler( handler)

   :param handler: None
   :type handler: AssertFailedHandler


   Set a custom code assert failed handler. 

   If specified, any failing assert conditions internally in the HOOPS Envision Web code will trigger this callback.

   If not specified, the failed assert will be logged and then an exception will be thrown (potentially stopping the app).


   :rtype: void

