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


The following tables list the members exposed by PointLineSceneEntity.

Public Constructors
 NameDescription
Public ConstructorPointLineSceneEntity ConstructorInitializes a new instance of the PointLineSceneEntity class.  
Top
Protected Fields
 NameDescription
Protected Field_renderableSeriesThe wrapped BaseRenderableSeries3D instance that we are drawing (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Protected Field_xCalcThe XAxis SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator<T>, which converts pixel to world coordinates. Valid for the current render pass only (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Protected Field_yCalcThe YAxis SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator<T>, which converts pixel to world coordinates. Valid for the current render pass only (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Protected Field_zCalcThe ZAxis SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator<T>, which converts pixel to world coordinates. Valid for the current render pass only (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Protected FieldSceneEntityHelperThe strategy for dealing with 3D Geometry in the scene for different data schemas (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Top
Public Properties
 NameDescription
Public PropertyChildrenGets the collection of children for this entity. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public PropertyEntityIdGets or sets a unique System.UInt32 identifier for this entity. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public PropertyEntityIdProvider

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 PropertyIsDirtyWhen true, meshes need to be recreated on the next Render Pass (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public PropertyIsVisibleOverridden. Gets or sets whether this entity is visible or not.  
Public PropertyParentGets or sets the parent SciChart.Charting3D.Primitives.IBaseSceneEntity (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public PropertyRequiresSelectionId

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 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 PropertyRootSceneEntityGets the SciChart.Charting3D.IRootSceneEntity at the root of the (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public PropertyViewport3DGets the SciChart.Charting3D.IViewport3D instance that hosts this root entity (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
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

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
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

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
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

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodBeginLitMeshBegins 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 MethodBeginMeshBegins 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 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

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

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

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodChangeHelperChanges the Scene Entity Helper: a strategy for dealing with 3D Geometry in the scene for different data schemas (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Public MethodCreateMeshesOverridden. When overridden in a derived class, creates meshes from SciChart.Charting3D.Primitives.IRenderPassInfo3D and SciChart.Charting3D.Model.IPointSeries3D data  
Public MethodDisposeOverloaded. Releases unmanaged and - optionally - managed resources. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodGetEntity<T>Gets the first child entity of type T (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodGetHeightmapIndicesGets 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 MethodGetKindGets Scene Entity Kind that determines rendering pass during which scene entity has to be rendered. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodGetMetadata (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Public MethodGetSelectionIdOverloaded. 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 MethodGetVertexAtGets the X,Y,Z Vertex in world-coordinates nearest the Hit-test site specified by HitTestInfo3D (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Public MethodGetVertexCoordsGets the X,Y,Z Vertex coordinate in world-coordinates nearest the Hit-test site specified by HitTestInfo3D (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Public MethodHitTestOverridden. Performs a HitTest operation on the BaseRenderableSeriesSceneEntity3D, returning the HitTestInfo3D containing the result  
Public MethodInvalidateSceneForces the entire scene to redraw (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodIsTransparent (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodOnAttachedCalled immediately after an entity is attached to a parent (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodOnDetachedCalled immediately before an entity is detached from a parent (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodOnEngineRestartCalled when the D3DEngine Restarts. Meshes and DirectX related objects should be recreated (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodOverrideOpacityOverridden. Overrides the opacity of the entity.  
Public MethodPerformSelectionPerforms selection on this entity, setting the IsSelected flag to True or False on the specified Vertex Ids (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Public MethodRenderRenders this entity with the current scene and render pass data (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodRenderSceneOverridden. Called when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene  
Public MethodSetRenderPassDataSets the current SciChart.Charting3D.Primitives.IRenderPassInfo3D, which contains the data needed for this render pass. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodToSeriesInfoOverridden. Converts a HitTestInfo3D struct, containing information about a Hit-Test operation, into a SciChart.Charting3D.Model.ChartData.SeriesInfo3D, which is a viewmodel for tooltips, legends in the SciChart.Charting3D.SciChart3DSurface libary  
Public MethodUpdateOverloaded. Updates this entity with the current scene time (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Public MethodUpdateSceneCalled when the 3D Engine wishes to update the geometry in this element. This is where we need to cache geometry before draw. (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
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

(Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Top
Protected Methods
 NameDescription
Protected MethodAttachChildAttaches a SciChart.Charting3D.Primitives.IBaseSceneEntity to the Children collection. (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Protected MethodDetachChildDetaches a SciChart.Charting3D.Primitives.IBaseSceneEntity and removes from the Children collection (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Protected MethodFinalizeAllows 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 MethodGetBitmapCreates a System.Windows.Media.Imaging.WriteableBitmap with the given dimentions and fills it using the brush. (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Protected MethodGetTextureCreates a SciChart.Charting3D.Texture2D with the given dimentions and fills it using the brush. (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
Protected MethodOnChildEntitiesCollectionChangedCalled when the Children child entities collection changes (Inherited from SciChart.Charting3D.Primitives.BaseSceneEntity)
Protected MethodUpdateMeshesOverridden. When overridden in a derived class, updates all 3D meshes from Data  
Protected MethodUpdatePointMarkerColorCalled by a SceneEntity to update pointsMesh if a IPaletteProvider3D is used. (Inherited from SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D)
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

PointLineSceneEntity Class
SciChart.Charting3D.RenderableSeries Namespace

 

 


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

Send Feedback