iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

SCIDisplaceableFreeSurfaceDataSeries3D

@interface SCIDisplaceableFreeSurfaceDataSeries3D
    : SCIFreeSurfaceDataSeries3D <ISCIDisplaceableFreeSurfaceDataSeries3DValues>

2D grid based free shaped 3D surface with displacement.

Warning

Designed to be an abstract class, hence should be used for inheritance only. No direct initializations.


                        
                        
                        -initWithXType:yType:zType:displacementType:uSize:vSize:uMin:uMax:vMin:vMax:

Initializer for this instance of SCIFreeSurfaceDataSeries3D.

Declaration

Objective-C

- (nonnull instancetype)initWithXType:(SCIDataType)xType
                                yType:(SCIDataType)yType
                                zType:(SCIDataType)zType
                     displacementType:(SCIDataType)displacementType
                                uSize:(NSInteger)uSize
                                vSize:(NSInteger)vSize
                                 uMin:(double)uMin
                                 uMax:(double)uMax
                                 vMin:(double)vMin
                                 vMax:(double)vMax;

Swift

init(xType: SCIDataType, yType: SCIDataType, zType: SCIDataType, displacementType: SCIDataType, uSize: Int, vSize: Int, uMin: Double, uMax: Double, vMin: Double, vMax: Double)

Parameters

`xType`	The type of X data.
`yType`	The type of Y data.
`zType`	The type of Z data.
`displacementType`	The type of displacement data.
`uSize`	The uSize of the 2D grid.
`vSize`	The vSize of the 2D grid.
`uMin`	The minimum value of U component of the 2D grid.
`uMax`	The maximum value of U component of the 2D grid.
`vMin`	The minimum value of V component of the 2D grid.
`vMax`	The maximum value of V component of the 2D grid.


                        
                        
                        -setDisplacement:uIndex:vIndex:

Sets the displacement at specified position.

Declaration

Objective-C

- (void)setDisplacement:(nonnull id<ISCIComparable>)displacement
                 uIndex:(NSInteger)uIndex
                 vIndex:(NSInteger)vIndex;

Parameters

`uIndex`	The uIndex of point to update.
`vIndex`	The vIndex of point to update.
`displacement`	The new yValue.


                        
                        
                        -pushArrayRow:

Pushes a row into the data series, which discards one old row in a First In First Out fashion. use this method to scroll the SCIGridData in the Z-direction.

Declaration

Objective-C

- (void)pushArrayRow:(nonnull NSArray *)array;

Parameters


                                    array

The row with new values.


                        
                        
                        -pushValuesRow:

Pushes a row into the data series, which discards one old row in a First In First Out fashion. use this method to scroll the SCIGridData in the Z-direction.

Declaration

Objective-C

- (void)pushValuesRow:(nonnull id<ISCIValues>)values;

Swift

func push(_ values: any ISCIValues)

Parameters


                                    values

The row with new values.


                        
                        
                        -setArrayRow:at:

Sets the row at the specified Z index.

Declaration

Objective-C

- (void)setArrayRow:(nonnull NSArray<id<ISCIComparable>> *)row
                 at:(NSInteger)index;

Parameters

`index`	The z-index to use.
`row`	The row with new values.


                        
                        
                        -setValuesRow:at:

Sets the row at the specified Z index.

Declaration

Objective-C

- (void)setValuesRow:(nonnull id<ISCIValues>)row at:(NSInteger)index;

Swift

func set(_ row: any ISCIValues, at index: Int)

Parameters

`index`	The z-index to use.
`row`	The row with new values.


                        
                        
                        -copyFromArray:

Copies array to this instance.

Declaration

Objective-C

- (void)copyFromArray:(nonnull NSArray<id<ISCIComparable>> *)array;

Parameters


                                    array

The array to copy from.


                        
                        
                        -copyFromValues:

Copies values to this instance.

Declaration

Objective-C

- (void)copyFromValues:(nonnull id<ISCIValues>)values;

Swift

func copy(from values: any ISCIValues)

Parameters


                                    values

Values to copy from.