Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

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

Hierarchy

Implemented by

Index

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.

entityId

entityId: number

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

Readonly id

id: string

A unique Id for the IBaseSceneEntity

isVisible

isVisible: boolean

When true, the entity and it's children are visible in the 3D Scene

nativeEntity

nativeEntity: SCRTSceneEntity

Gets the native SCRTSceneEntity - a WebAssembly 3D Scene Entity type which is passed to our WebGL WebAssembly 3D Engine

parent

Gets the parent IBaseSceneEntity

Readonly type

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

Methods

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

getEntity

getRoot

  • Gets the root entity in the 3D Scene

    Returns RootSceneEntity

onAttached

  • onAttached(): void
  • Called when the IBaseSceneEntity is attached to the parent scene

    Returns void

onDetached

  • onDetached(): void
  • Called when the IBaseSceneEntity is detached from the parent scene

    Returns void

Protected 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

setRenderPassData

  • Sets the RenderPassInfo3D - render pass info, properties and data for the current rendering pass

    Parameters

    Returns void

visitEntities

  • Visitor function to perform on this entity and all it's children

    Parameters

    Returns void

Generated using TypeDoc