Options
All
  • Public
  • Public/Protected
  • All
Menu

The BaseSceneEntity3D provides a base class for entities, or 3D objects in the 3D scene within SciChart's High Performance JavaScript 3D Charts

remarks

Each BaseSceneEntity3D wraps a native WebAssembly SCRTSceneEntity which is returned by the nativeEntity property. This is passed to SciChart's 3D engine and inserted into the scene when added to the SciChart3DSurface.rootEntity collection.

Type parameters

  • TNativeEntity: SCRTSceneEntity

Hierarchy

Implements

Index

Constructors

Protected constructor

  • Creates an instance of the BaseSceneEntity3D

    Parameters

    • webAssemblyContext: TSciChart3D

      The {@link TSciChart3D | SciChart 3D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

    Returns BaseSceneEntity3D

Properties

Readonly children

summary

Gets the collection of IBaseSceneEntity - child entities or 3D Objects which belong to this entity.

description

A SciChart3DSurface has a SciChart3DSurface.rootEntity property. You can add BaseSceneEntity3D to this property, and each entity can have a collection of child entities.

Use grouping to control visibility of many entities at once, or to create more complex scenes.

remarks

Adding a BaseSceneEntity3D to the children collection will cause the 3D Scene to be redrawn.

Protected currentRenderPassData

currentRenderPassData: RenderPassInfo3D

The RenderPassInfo3D containing data about the current rendering pass

Readonly id

id: string = generateGuid()

A unique Id for the IBaseSceneEntity

isVisible

isVisible: boolean = true

When true, the entity and all its children are visible

parent

Gets the parent Entity

Readonly rootSceneEntity

rootSceneEntity: RootSceneEntity
inheritdoc

Readonly Abstract type

Gets the type of Scene Entity. See ESceneEntityType for a list of values

Protected Readonly webAssemblyContext

webAssemblyContext: TSciChart3D

The {@link TSciChart3D | SciChart 3D WebAssembly Context} containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

Accessors

entityId

  • get entityId(): number
  • set entityId(value: number): void
  • A unique integer ID for the entity. This will be auto-generated and used to identify the entity later when tooltips are used

    inheritdoc

    Returns number

  • A unique integer ID for the entity. This will be auto-generated and used to identify the entity later when tooltips are used

    inheritdoc

    Parameters

    • value: number

    Returns void

nativeEntity

  • get nativeEntity(): TNativeEntity
  • Gets the native SCRTSceneEntity - a WebAssembly 3D Scene Entity type which is passed to our WebGL WebAssembly 3D Engine

    inheritdoc

    Returns TNativeEntity

Protected world

  • get world(): SCRTSceneWorld
  • Called internally - gets the world entity

    Returns SCRTSceneWorld

Methods

Render

  • Render(): void
  • Render method called from WebAssembly engine. Use this to do immediate-mode 3D drawing, or to draw created meshes When overriding, you must call super.Update() for the object to draw in the scene

    Returns void

Update

  • Update(deltaTime: number): void
  • Update method called from WebAssembly engine. Use this to update meshes, properties, geometry before draw. When overriding, you must call super.Update() for the object to draw in the scene

    Parameters

    • deltaTime: number

    Returns void

Protected attachChild

  • Called internally - Attach a child to the current entity

    Parameters

    Returns void

delete

  • delete(): void
  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

Protected detachChild

  • Called internally - detach a child from the current entity

    Parameters

    Returns void

getEntity

getRoot

invalidateScene

  • invalidateScene(): void
  • Call this to inform SciChart that data or properties have changed and the 3D Scene must be redrawn

    Returns void

onAttached

  • onAttached(): void

onDetached

  • onDetached(): void

onDpiChanged

  • Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor

    Parameters

    Returns void

onEngineRestart

  • onEngineRestart(): void
  • Called when the WebGL 3D Engine restarts. Use this to perform clean-up operations

    Returns void

Protected setNativeEntity

  • setNativeEntity(entity: TNativeEntity): void
  • Called internally - sets the native entity

    Parameters

    • entity: TNativeEntity

    Returns void

setRenderPassData

visitEntities

Generated using TypeDoc