Fields  Properties  Methods 


XyzGizmo Class Members

The following tables list the members exposed by XyzGizmo.

Public Constructors
 NameDescription
Public Constructor  
Top
Protected Fields
Public Properties
 NameDescription
Public PropertyGets or sets  
Public PropertyGets the collection of children for this entity. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Property  
Public PropertyGets or sets a unique System.UInt32 identifier for this entity. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Property

Gets or sets an SciChart.Charting3D.Primitives.IEntityIdProvider which encodes and decodes SciChart.Charting3D.Primitives.VertexIds

VertexIds consist of MeshID (object ID) and vertex ID.

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public PropertyWhen true, meshes need to be recreated on the next Render Pass (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public PropertyGets or sets whether this entity is visible or not. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public Property  
Public PropertyGets or sets the parent SciChart.Charting3D.Primitives.IBaseSceneEntity (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Property

Gets a value indicating whether this entity requires a SelectionID.

If TRUE (default), then the SciChart.Charting3D.Primitives.IEntityIdProvider.GetEntityId method will be called on setting SciChart.Charting3D.Primitives.BaseSceneEntity.EntityIdProvider. This selection ID is passed through to the 3D Graphics engine to enable selection, tooltips on the entity.

If FALSE, then no entity ID will be set. It will be the default value of System.UInt32.MaxValue. The item will be considered ignored for selection and tooltips.

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public PropertyGets the SciChart.Charting3D.IRootSceneEntity at the root of the (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public PropertyGets the SciChart.Charting3D.IViewport3D instance that hosts this root entity (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Top
Public Methods
 NameDescription
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method

Begins an Immediate Columns Mesh, which can be used to draw dynamic columns on the fly.

Accepts which defines the geometry of the 3D column

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Method

Begins an Immediate Lines Mesh, which can be used to draw dynamic continuous (Poly) 3D lines on the fly.

Accepts System.Single StrokeThickness which defines the stroke thickness in world coordinates for the line

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Method

Begins an Immediate Lines Mesh, which can be used to draw dynamic disjointed (discontinuous) 3D lines on the fly.

Accepts System.Single StrokeThickness which defines the stroke thickness in world coordinates for the line

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodBegins an Immediate Mesh, which can be used to draw dynamic 3D meshes on the fly. Accepts SciChart.Charting3D.Primitives.TSRRenderMode which defines the DirectX primitive type (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodBegins an Immediate Mesh, which can be used to draw dynamic 3D meshes on the fly. Accepts SciChart.Charting3D.Primitives.TSRRenderMode which defines the DirectX primitive type (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Method

Begins an Immediate Points Mesh, which can be used to draw dynamic points (as textures, pixels or 3D models) on the fly.

Accepts pointMarker which defines the geometry of the 3D point

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Method

Begins an Immediate Solid Mesh, which can be used to draw dynamic 3D planes on the fly.

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodOverloaded. Overridden. Releases unmanaged and - optionally - managed resources.  
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodGets the first child entity of type T (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodGets the heightmap indices under the mouse point. Use SciChart.Charting3D.Primitives.IEntityIdProvider to decode into mesh and vertex Ids (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodGets Scene Entity Kind that determines rendering pass during which scene entity has to be rendered. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodOverloaded. Gets the selection identifier under the mouse point. Use SciChart.Charting3D.Primitives.IEntityIdProvider to decode into mesh and vertex Ids (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodForces the entire scene to redraw (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodCalled immediately after an entity is attached to a parent (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodCalled immediately before an entity is detached from a parent (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodCalled when the D3DEngine Restarts. Meshes and DirectX related objects should be recreated (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodOverridden. Performs selection on this entity, setting the IsSelected flag to True or False on the specified Vertex Ids  
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodRenders this entity with the current scene and render pass data (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodOverridden. Called when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene  
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodSets the current SciChart.Charting3D.Primitives.IRenderPassInfo3D, which contains the data needed for this render pass. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodOverloaded. Updates this entity with the current scene time (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodOverridden. Called when the 3D Engine wishes to update the geometry in this element. This is where we need to cache geometry before draw.  
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method

Implements the Visitor Pattern, visiting all Child entities (and their children) performing the operation on each one.

Use this when you want to set a property on all entities in the scene, or perform a certain function on all entities

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Top
Protected Methods
 NameDescription
Protected MethodAttaches a SciChart.Charting3D.Primitives.IBaseSceneEntity to the SciChart.Charting3D.Primitives.BaseSceneEntity.Children collection. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Protected MethodDetaches a SciChart.Charting3D.Primitives.IBaseSceneEntity and removes from the SciChart.Charting3D.Primitives.BaseSceneEntity.Children collection (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Protected MethodAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Protected MethodCalled when the SciChart.Charting3D.Primitives.BaseSceneEntity.Children child entities collection changes (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Top
Extension Methods
 NameDescription
Public Extension MethodChecks for null and if not null, calls Dispose
Public Extension MethodYields a single item, converting it to System.Collections.IEnumerable.
Public Extension Method
Top
See Also