Fields  Properties  Methods 


BaseSceneEntity<T> Class Members

The following tables list the members exposed by BaseSceneEntity<T>.

Protected Constructors
 NameDescription
Protected ConstructorInitializes a new instance of the BaseSceneEntity<T> class.  
Top
Protected Fields
Public Properties
 NameDescription
Public PropertyGets the collection of children for this entity.  
Public PropertyGets or sets a unique System.UInt32 identifier for this entity.  
Public Property

Gets or sets an IEntityIdProvider which encodes and decodes VertexIds

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

 
Public PropertyWhen true, meshes need to be recreated on the next Render Pass  
Public PropertyGets value determining whether the instance has already been disposed.  
Public PropertyGets value determining whether the instance has already been finalized.  
Public PropertyGets or sets whether this entity is visible or not.  
Public Property (Inherited from SciChart.Charting3D.Interop.TSRSceneEntity)
Public Property (Inherited from SciChart.Charting3D.Interop.TSRSceneEntity)
Public PropertyGets or sets the parent IBaseSceneEntity  
Public Property

Gets a value indicating whether this entity requires a SelectionID.

If TRUE (default), then the IEntityIdProvider.GetEntityId method will be called on setting 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.

 
Public PropertyGets the SciChart.Charting3D.IRootSceneEntity at the root of the  
Public PropertyGets the SciChart.Charting3D.IViewport3D instance that hosts this root entity  
Top
Public Methods
 NameDescription
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
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

 
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

 
Public MethodBegins an Immediate Mesh, which can be used to draw dynamic 3D meshes on the fly. Accepts TSRRenderMode which defines the DirectX primitive type  
Public MethodBegins an Immediate Mesh, which can be used to draw dynamic 3D meshes on the fly. Accepts TSRRenderMode which defines the DirectX primitive type  
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

 
Public Method

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

 
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 Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodGets the first child entity of type T  
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodOverridden. Gets Scene Entity Kind that determines rendering pass during which scene entity has to be rendered.  
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.TSRExposedObject)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.TSRSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodOverloaded.   
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.TSRSceneEntity)
Public MethodForces the entire scene to redraw  
Public MethodGets or sets whether this entity is visible or not. (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodOverloaded.  (Inherited from SciChart.Charting3D.Interop.TSRExposedObject)
Public MethodOverloaded.  (Inherited from SciChart.Charting3D.Interop.TSRExposedObject)
Public MethodCalled immediately after an entity is attached to a parent  
Public MethodCalled immediately before an entity is detached from a parent  
Public MethodOverridden. Called when the D3DEngine Restarts. Meshes and DirectX related objects should be recreated  
Public Method (Inherited from SciChart.Charting3D.Interop.TSRExposedObject)
Public MethodPerforms selection on this entity, setting the IsSelected flag to True or False on the specified Vertex Ids  
Public Method (Inherited from SciChart.Charting3D.Interop.TSRExposedObject)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodOverridden. Renders this entity with the current scene and render pass data  
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodCalled when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene  
Public MethodOverloaded.  (Inherited from SciChart.Charting3D.Interop.TSRExposedObject)
Public MethodOverloaded.  (Inherited from SciChart.Charting3D.Interop.TSRExposedObject)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.TSRExposedObject)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodSets the current IRenderPassInfo3D, which contains the data needed for this render pass.  
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 Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.TSRSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public Method (Inherited from SciChart.Charting3D.Interop.SCRTSceneEntity)
Public MethodOverloaded. Overridden. Updates this entity with the current scene time  
Public MethodCalled 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

 
Top
Protected Methods
 NameDescription
Protected MethodAttaches a IBaseSceneEntity to the Children collection.  
Protected MethodDetaches a IBaseSceneEntity and removes from the Children collection  
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.Interop.TSRExposedObject)
Protected MethodCalled when the Children child entities collection changes  
Top
Extension Methods
 NameDescription
Public Extension MethodNotifies that finalizer has been invoked
Public Extension MethodChecks for null and if not null, calls Dispose
Public Extension MethodOverloaded. Converts an System.IComparable array to double array
Public Extension MethodYields a single item, converting it to System.Collections.IEnumerable.
Public Extension Method
Top
See Also