ProtectedconstructorInternal: Initial setup of runtime. See initializeModule for the rest.
CogsInternal: Do not use! Required for internal Cogs signaling Clients must use Control.addEventListener("postRender", e) to be notified after each render update.
CogsInternal: Do not use! Required for internal Cogs signaling Clients must use Control.addEventListener("preRender", e) to be notified before each render update.
Internal. Get Optional texture loading func.
Component in Extension AxisCube
Instantiates an asset model into the scene.
Entity in Extension AxisCube
A cube with grids on the side faces.
Entity in Extension AxisCube
Entity in Extension AxisCube
Entity in Extension BadgeSet
Component in Extension BadgeSet
Alias for Entity create of OceanRectangle
Renders a square billboard oriented towards the screen, positioned by the transform given by the TransformComponent.
Entity in Extension Casing
Component in Extension Physics
Bridge
Entity: Render multiple views simultaneously
Multi-view: Render a set of related views into array texture layers.
Defines a camera.
Component in Extension Physics
Entity in Extension Casing
Sets up a clipping shape that can be used by multiple entities.
Component that attaches a ClipShape to an entity.
Component in Extension Physics
Alias for Entity create of LookupColorMap
Contains basic Component definitions
Component in Extension Physics
Entity: Cube with center at origin and extents +- 1
Entity in Extension AxisCube
Component in Extension AxisCube
Entity in Extension CurtainView
Component in Extension CurtainView
Component in Extension Physics
Entity in Extension HeightMap
Component in Extension HeightMap
Entity in Extension AxisCube
Component in Extension AxisCube
Entity in Extension Drilling
Entity in Extension Drilling
Entity in Extension Drilling
Entity in Extension Drilling
Entity without any components, allows user to populate own components
Component in Extension Physics
Gets class containing 'wrap' method. To get complete entity description from EntityId using: runtime.Entity.wrap(id: EntityId);
Component in Extension Physics
Contains data to describe fog.
Creates fontHandle from Font+Size passing handle to other components having the 'fontHandle' field.
Component in Extension Physics
CogsInternal: Gets WebGL1 and WebGL2 common interface
CogsInternal: Gets WebGLRenderingContext. Requires webGLVersion === 1. Throws if invalid usage.
CogsInternal: Gets WebGL2RenderingContext. Requires webGLVersion === 1 Throws if invalid usage.
Entity: Container Entity with transform and children
Gets Height of canvas
Entity in Extension HeightMap
Component in Extension HeightMap
Entity in Extension WellLog
Component in Extension Physics
Entity in Extension Image360
Component in Extension Image360
Renders a mesh using instancing.
Defines a single light source and its behavior.
Contains data describing level of detail behavior for the entity the component belongs to.
Component in Extension Casing
Internal: Get logging instance
Entity: Colormap Entity. Store colormap as texture in MaterialComponent. Sample usage: HeightMapComponent.colorMap, ZipComponent.colorMap
! Generate a set of points for the given position array.
Exposes material properties for legacy entities and code.
Component in Extension Physics
Contains a handle to a Mesh resource to use when rendering using the MeshRenderComponent.
Generates mesh data and assigns the generated mesh to a MeshComponent on the same entity.
Renders the contents of a MeshComponent using the given materials.
Contains a model reference to instance as children to the entity the ModelComponent belongs to.
WASM module, really IWASMmodule
Contains motion data.
Entity in Extension MultiphaseFlow
Component in Extension MultiphaseFlow
Contains data to describe fog.
Get notification manager that handles component notifications.
Entity: OGC 3DTiles entity. Extension OGC3DTiles
Component in Extension OGC3DTiles
Component that calculates position and orientation of the entity TransformComponent.
Overlay component.
Component in Extension Physics
Component for Point Cloud Display.
Entity in Extension Potree
Entity in Extension ProceduralSky
Component in Extension ProceduralSky
Entity in Extension Drilling
Component in Extension Drilling
Base component for all rendering content.
Entity for Reservoir display. Extension Reservoir
Component returning information of the Reservoir case opened in the Entity.
Graphics for Reservoir data display. Draws full volume or a I/J/K section of the reservoir.
Component in Extension Physics
Component in Extension Drilling
Component in Extension Drilling
Component in Extension Drilling
Component in Extension Drilling
Contains information on how the entity behaves in the scene.
Allows to control the screen size of the entity.
Entity in Extension SeaCurrents
Component for displaying surface currents based on the IHO S111 standard.
Alias for Entity create of GenericShape
Entity: Sphere with center at origin and radius 1
Component in Extension Physics
Component in Extension Physics
Renders a mesh with flexible submesh usage.
Signals that an entity should only have one visible child at any time.
Entity in Extension Drilling
Component in Extension Drilling
Entity in Extension TexAtlas
Component in Extension TexAtlas
Renders the given text(s) by generating sprites.
Generates texture data and assigns the texture to either a MaterialComponent on the entity or the set material target.
Aligns the entity along a trajectory at a specified depth.
Data component defining a 3D trajectory, for example a Well trajectory.
Component in Extension Casing
Entity in Extension Casing
Defines a 4x4 transformation matrix for the entity and a global offset for root entities.
Component in Extension Physics
Entity in Extension VectorField
Component in Extension VectorField
The WebGL renderer string if it was exposed.
The WebGL vendor string if it was exposed.
The actual version of the WebGL context, zero if there is no WebGL context.
Entity in Extension WellLog
Gets Width of canvas
Entity: WireFrame Cube with center at origin and extents +- 1
Component displaying a 3D log on a trajectory.
Clear all entities and set up new context
Remove entity from Cogs entity lookup table. Entity is destroyed if not in use by other entities.
Entity to remove.
Erase a Cogs config variable.
Full name of the variable
True if variable found.
Get a Cogs boolean config variable.
Full name of the variable
Variable value.
Get a Cogs number config variable.
Full name of the variable
Variable value.
Get miscellaneous resource statistics.
To get more precise numbers on allocations, passing 'malinfo': 1 in options invokes calling of malinfo that traverses the malloc allocation structures. This might be costly, so we have this as opt-in for now.
Optionaloptions: { malinfo?: boolean }Get a Cogs config variable.
Full name of the variable
Variable value.
Check if a Cogs config variable exists.
Full name of the variable
True if Variable exists.
Load scene graph from Resource url. The resource must be registered as a string resource using Resources.registerStringResource.
Resource url
Optional parent entity. Recommended for clean-up.
Optionalflags: AssetLoadFlagsOptional Loading flags =AssetLoadFlags.NoDefault
true if success
Load scene graph from JSON definition.
Asset definition
Optional parent entity. Recommended for clean-up.
Optionalflags: AssetLoadFlagsOptional Loading flags =AssetLoadFlags.NoDefault
true if success
Adds a new extension (e.g. Physics, Potree etc), returns true if extension found and loaded
Load scene graph from Resource url The resource must be registered as a string resource using Resources.registerStringResource.
Resource url
Optionalflags: AssetLoadFlagsLoading flags. AssetLoadFlags.ClearScene can be used to clear scene contents. =AssetLoadFlags.NoDefault
true if success
Resize drawing area
Internal: set DPI and scalingFactor
Set a Cogs config variable. Internally sent as string. Use getVariable/getBoolVariable/getDoubleVariable to get variable value.
Full name of the variable
New variable value.
Exposed as control.runtime
The Runtime class is a main class in Cogs.js owning the Scene, Bridge, Resources etc.
Entities and Components are exposed as data members on the runtime. Note: This definition is a static definition and members of extensions will not be available until the Extension is loaded.
In the TypeScript interface to Cogsengine can drill down into each entity to find the components that it consists of. Components are reused across entities.