WPF Charting Documentation - SciChart WPF Charts SDK v5.x
BaseSceneEntity Class Members
Properties  Methods 


The following tables list the members exposed by BaseSceneEntity.

Protected Constructors
 NameDescription
Protected ConstructorBaseSceneEntity ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyChildrenGets the collection of children for this entity.  
Public PropertyEntityIdGets or sets a unique System.UInt32 identifier for this entity.  
Public PropertyEntityIdProvider

Gets or sets an IEntityIdProvider which encodes and decodes VertexIds

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

 
Public PropertyIsDirtyWhen true, meshes need to be recreated on the next Render Pass  
Public PropertyIsVisibleGets or sets whether this entity is visible or not.  
Public PropertyParentGets or sets the parent IBaseSceneEntity  
Public PropertyRequiresSelectionId

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 PropertyRootSceneEntityGets the SciChart.Charting3D.IRootSceneEntity at the root of the  
Public PropertyViewport3DGets the SciChart.Charting3D.IViewport3D instance that hosts this root entity  
Top
Public Methods
 NameDescription
Public MethodBeginColumns

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

 
Public MethodBeginLines

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 MethodBeginLineStrips

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

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 MethodBeginSolidMesh

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

 
Public MethodDisposeOverloaded. Overridden. Releases unmanaged and - optionally - managed resources.  
Public MethodGetEntity<T>Gets the first child entity of type T  
Public MethodGetHeightmapIndicesGets the heightmap indices under the mouse point. Use IEntityIdProvider to decode into mesh and vertex Ids  
Public MethodGetKindOverridden. Gets Scene Entity Kind that determines rendering pass during which scene entity has to be rendered.  
Public MethodGetSelectionIdOverloaded. Gets the selection identifier under the mouse point. Use IEntityIdProvider to decode into mesh and vertex Ids  
Public MethodInvalidateSceneForces the entire scene to redraw  
Public MethodIsTransparentOverridden.   
Public MethodOnAttachedCalled immediately after an entity is attached to a parent  
Public MethodOnDetachedCalled immediately before an entity is detached from a parent  
Public MethodOnEngineRestartOverridden. Called when the D3DEngine Restarts. Meshes and DirectX related objects should be recreated  
Public MethodPerformSelectionPerforms selection on this entity, setting the IsSelected flag to True or False on the specified Vertex Ids  
Public MethodRenderOverridden. Renders this entity with the current scene and render pass data  
Public MethodRenderSceneCalled when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene  
Public MethodSetRenderPassDataSets the current IRenderPassInfo3D, which contains the data needed for this render pass.  
Public MethodUpdateOverloaded. Overridden. Updates this entity with the current scene time  
Public MethodUpdateSceneCalled when the 3D Engine wishes to update the geometry in this element. This is where we need to cache geometry before draw.  
Public MethodVisitEntities

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 MethodAttachChildAttaches a IBaseSceneEntity to the Children collection.  
Protected MethodDetachChildDetaches a IBaseSceneEntity and removes from the Children collection  
Protected MethodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.  
Protected MethodOnChildEntitiesCollectionChangedCalled when the Children child entities collection changes  
Top
Extension Methods
 NameDescription
Public Extension MethodSafeDisposeChecks for null and if not null, calls Dispose
Public Extension MethodToEnumerable<T>Yields a single item, converting it to System.Collections.IEnumerable.
Public Extension MethodToStringArray2D<T>
Top
See Also

Reference

BaseSceneEntity Class
SciChart.Charting3D.Primitives Namespace

 

 


SCICHART ® is a Registered Trademark in the UK, US and EU. Copyright SciChart Ltd 2011-2018.

Send Feedback