FreeSurfaceDataSeries3D<TX,TY,TZ> Class Members
The following tables list the members exposed by FreeSurfaceDataSeries3D<TX,TY,TZ>.
Protected Constructors
| Name | Description | |
|---|---|---|
 | FreeSurfaceDataSeries3D<TX,TY,TZ> Constructor |
Public Fields
| Name | Description | |
|---|---|---|
 | SyncRoot | The Synchronization Object for the DataSeries3D. (Inherited from SciChart.Charting3D.Model.DataSeries3D) |
Protected Fields
Public Properties
| Name | Description | |
|---|---|---|
 | IsDirty | Gets or sets a value indicating whether this instance is dirty. If dirty, any cached data must be re-calculated. You can set this value to True to force recalculation of caches. (Inherited from SciChart.Charting3D.Model.HeightmapBasedDataSeries3D) |
| IsHeightmapDirty | Overridden. Gets or sets value determining whether the heightmap is dirty. If dirty, cached data must be re-calculated. |
| IsMeshDirty | Overridden. Gets or sets value determining whether the mesh is dirty. If dirty, cached data must be re-calculated. |
| IsSuspended | Gets a value indicating whether updates for the target are currently suspended. (Inherited from HeightmapBasedDataSeries3D) |
| OffsetX | Gets or sets a data offset by X axis of the Surface. |
| OffsetY | Gets or sets a data offset by Y axis of the Surface. |
| OffsetZ | Gets or sets a data offset by Z axis of the Surface. |
| ParentSurface | Gets or sets the parent SciChart.Charting3D.ISciChart3DSurface which this IDataSeries3D instance is attached to. (Inherited from HeightmapBasedDataSeries3D) |
| SeriesName | Gets or sets the name of this series. (Inherited from HeightmapBasedDataSeries3D) |
| UCount | Gets number of U segments of the 2D grid. |
| VCount | Gets number of V segments of the 2D grid. |
| XRange | Overridden. Gets the total extents of the IDataSeries3D in the X direction. |
| YRange | Overridden. Gets the total extents of the IDataSeries3D in the Y direction. |
| ZRange | Overridden. Gets the total extents of the IDataSeries3D in the Z direction. |
Public Methods
| Name | Description | |
|---|---|---|
 | Clear | Overridden. Clears the DataSeries. |
| DecrementSuspend | Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called. (Inherited from SciChart.Charting3D.Model.DataSeries3D) |
| GetBounds | Gets the bounding box for the data (containing XRange, YRange, ZRange). (Inherited from HeightmapBasedDataSeries3D) |
| GetDataValue | Gets the 3-Dimensional data value by specified UV index of the 2D grid in the surface. |
| GetDisplacedDataValue | Gets the 3-Dimensional data value with the Displacement Map value applied. |
| GetU | Gets the U coordinate by passed index of the 2D grid. |
| GetV | Gets the V coordinate by passed index of the 2D grid. |
| InvalidateParentSurface | May be called to trigger a redraw on the parent SciChart.Charting3D.SciChart3DSurface. This method is extremely useful when IDataSeries3D are in a ViewModel and bound via MVVM to SciChart.Charting3D.RenderableSeries.IRenderableSeries3D. Please see the rangeMode parameter for invalidation options. (Inherited from HeightmapBasedDataSeries3D) |
| OnDataSeriesChanged | Raises the DataSeriesChanged event. May be called by DataSeries3D or by user code to trigger a redraw on the ParentSurface. The event is not raised while SciChart.Core.Framework.ISuspendable.IsSuspended is True. (Inherited from HeightmapBasedDataSeries3D) |
| ResumeUpdates | Resumes updates on the target, intended to be called by SciChart.Core.Framework.IUpdateSuspender. (Inherited from HeightmapBasedDataSeries3D) |
| SuspendUpdates | Overloaded. Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued. (Inherited from HeightmapBasedDataSeries3D) |
| ToPointSeries<TPointSeries> | Overridden. Converts a DataSeries to a IPointSeries3D derived type, for use during the render pass. |
Protected Methods
| Name | Description | |
|---|---|---|
 | CalculateRanges | |
| CreateUpdateSuspender | (Inherited from SciChart.Charting3D.Model.HeightmapBasedDataSeries3D) |
| MarkIsDirtyOnResumeUpdates | (Inherited from HeightmapBasedDataSeries3D) |
| OnIsHeightmapDirtyChanged | Invoked right after Dirty State changed to indicated that the heightmap is invalid. (Inherited from HeightmapBasedDataSeries3D) |
| OnIsMeshDirtyChanged | Invoked right after Dirty State changed to indicated that the mesh is invalid. (Inherited from HeightmapBasedDataSeries3D) |
| OnPropertyChanged | Overloaded. Raises the System.ComponentModel.INotifyPropertyChanged.PropertyChanged event (Inherited from HeightmapBasedDataSeries3D) |
Extension Methods
| Name | Description | |
|---|---|---|
 | DebugFinalizer<T> | Notifies that finalizer has been invoked |
| ToDoubleArray | Overloaded. Converts an System.IComparable array to double array |
| ToEnumerable<T> | Yields a single item, converting it to System.Collections.IEnumerable. |
| ToStringArray2D<T> |
Public Events
| Name | Description | |
|---|---|---|
 | DataSeriesChanged | Event raised whenever points are added to, removed or one or more DataSeries3D properties changes, requiring a redraw of the parent SciChartSurface. (Inherited from SciChart.Charting3D.Model.DataSeries3D) |
| PropertyChanged | Occurs when a property value changes. (Inherited from HeightmapBasedDataSeries3D) |
See Also