XzDisplaceableFreeSurfaceDataSeries<TXZ,TY> Class Members
The following tables list the members exposed by XzDisplaceableFreeSurfaceDataSeries<TXZ,TY>.
Protected Constructors
| Name | Description | |
|---|---|---|
 | XzDisplaceableFreeSurfaceDataSeries<TXZ,TY> Constructor |
Public Fields
| Name | Description | |
|---|---|---|
 | SyncRoot | The Synchronization Object for the DataSeries3D. (Inherited from SciChart.Charting3D.Model.DataSeries3D) |
Protected Fields
| Name | Description | |
|---|---|---|
 | _offsetX | (Inherited from SciChart.Charting3D.Model.FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _offsetY | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _offsetZ | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _uCount | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _uMax | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _uMin | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _vCount | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _vMax | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _vMin | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _xRange | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _yRange | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| _zRange | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
Public Properties
| Name | Description | |
|---|---|---|
 | InternalArray | Accesses the internal array. |
| 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 | Gets or sets value determining whether the heightmap is dirty. If dirty, cached data must be re-calculated. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| IsMeshDirty | Gets or sets value determining whether the mesh is dirty. If dirty, cached data must be re-calculated. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| IsSuspended | Gets a value indicating whether updates for the target are currently suspended. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| Item | Gets or sets Displacement Map value at the UV index. |
| OffsetX | Gets or sets a data offset by X axis of the Surface. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| OffsetY | Gets or sets a data offset by Y axis of the Surface. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| OffsetZ | Gets or sets a data offset by Z axis of the Surface. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| ParentSurface | Gets or sets the parent SciChart.Charting3D.ISciChart3DSurface which this IDataSeries3D instance is attached to. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| SeriesName | Gets or sets the name of this series. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| UCount | Gets number of U segments of the 2D grid. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| VCount | Gets number of V segments of the 2D grid. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| XRange | Gets the total extents of the IDataSeries3D in the X direction. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| YRange | Gets the total extents of the IDataSeries3D in the Y direction. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| ZRange | Gets the total extents of the IDataSeries3D in the Z direction. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
Public Methods
| Name | Description | |
|---|---|---|
 | Clear | Clears the DataSeries. (Inherited from SciChart.Charting3D.Model.FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| CopyFrom | Overloaded. Fills the ScalableXZFreeSurfaceDataSeries from a SciChart.Data.Model.GridData<T> type. |
| DecrementSuspend | Called by IUpdateSuspender each time a target suspender is disposed. When the final target suspender has been disposed, ResumeUpdates is called. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| GetBounds | Gets the bounding box for the data (containing XRange, YRange, ZRange). (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| GetDataDisplacement | Gets the displacement along the XZ axes in regards to Displacement Map data and UV coordinates. |
| GetDataValue | Gets the 3-Dimensional data value by specified UV index of the 2D grid in the surface. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| GetDisplacedDataValue | Gets the 3-Dimensional data value with the Displacement Map value applied. |
| GetRowAt | Returns the row at the specified Z Index |
| GetU | Gets the U coordinate by passed index of the 2D grid. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| GetV | Gets the V coordinate by passed index of the 2D grid. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| 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 FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| 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 FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| PushRow | Pushes a row into the array, which discards one old row in a First In First Out fashion. use this method to scroll the GridData in the Z-direction |
| ResumeUpdates | Resumes updates on the target, intended to be called by SciChart.Core.Framework.IUpdateSuspender. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| SetRowAt | Sets the row at the specified Z index |
| SuspendUpdates | Overloaded. Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| ToPointSeries<TPointSeries> | Overridden. Converts a DataSeries to a IPointSeries3D derived type, for use during the render pass. |
Protected Methods
| Name | Description | |
|---|---|---|
 | CalculateRanges | (Inherited from SciChart.Charting3D.Model.FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| CreateUpdateSuspender | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| MarkIsDirtyOnResumeUpdates | (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| OnIsHeightmapDirtyChanged | Invoked right after Dirty State changed to indicated that the heightmap is invalid. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| OnIsMeshDirtyChanged | Invoked right after Dirty State changed to indicated that the mesh is invalid. (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
| OnPropertyChanged | Overloaded. Raises the System.ComponentModel.INotifyPropertyChanged.PropertyChanged event (Inherited from FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
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 FreeSurfaceDataSeries3D<TXZ,TY,TXZ>) |
See Also