Class FreeSurfaceDataSeries3D<TX,TY,TZ>
2D grid based free shaped 3D surface.
Inheritance
Implements
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class FreeSurfaceDataSeries3D<TX,TY,TZ> extends dataSeries.DataSeries3D<TX,TY,TZ> implements dataSeries.freeSurface.IFreeSurfaceDataSeries3DValues<TX,TY,TZ>
Type Parameters
| Name | Description |
|---|---|
| TX | |
| TY | |
| TZ |
Constructors
FreeSurfaceDataSeries3D(Class<TX> xType, Class<TY> yType, Class<TZ> zType, int uSize, int vSize, double uMin, double uMax, double vMin, double vMax)
Creates a new FreeSurfaceDataSeries3D instance
Declaration
protected FreeSurfaceDataSeries3D(Class<TX> xType, Class<TY> yType, Class<TZ> zType, int uSize, int vSize, double uMin, double uMax, double vMin, double vMax)
Parameters
| Type | Name | Description |
|---|---|---|
| Class<TX> | xType | The type of X-Data |
| Class<TY> | yType | The type of Y-Data |
| Class<TZ> | zType | The type of Z-Data |
| int | uSize | The uSize of the 2D grid |
| int | vSize | The vSize of the 2D grid |
| double | uMin | The minimum value of U component of the 2D grid |
| double | uMax | The maximum value of U component of the 2D grid |
| double | vMin | The minimum value of V component of the 2D grid |
| double | vMax | The maximum value of V component of the 2D grid |
Fields
cachedXValues
Declaration
protected final DoubleValues cachedXValues
Field Value
| Type | Description |
|---|---|
| DoubleValues |
cachedYValues
Declaration
protected final DoubleValues cachedYValues
Field Value
| Type | Description |
|---|---|
| DoubleValues |
cachedZValues
Declaration
protected final DoubleValues cachedZValues
Field Value
| Type | Description |
|---|---|
| DoubleValues |
indexCalculator
Declaration
protected final dataSeries.freeSurface.MeshIndexCalculator indexCalculator
Field Value
| Type | Description |
|---|---|
| dataSeries.freeSurface.MeshIndexCalculator |
isCachedValuesDirty
Declaration
protected volatile boolean isCachedValuesDirty
Field Value
| Type | Description |
|---|---|
| boolean |
Methods
clear(boolean retainCapacity)
Declaration
public void clear(boolean retainCapacity)
Parameters
| Type | Name | Description |
|---|---|---|
| boolean | retainCapacity |
clearCachedValues(boolean retainCapacity)
Clears cached #cachedXValues, #cachedYValues and #cachedZValues.
Declaration
public void clearCachedValues(boolean retainCapacity)
Parameters
| Type | Name | Description |
|---|---|---|
| boolean | retainCapacity | If true series resets internal lists to zero size, otherwise internal arrays are recreated |
getCount()
Declaration
public final int getCount()
Returns
| Type | Description |
|---|---|
| int |
getOffsetX()
Gets a data offset by X axis of the Surface.
Declaration
public final TX getOffsetX()
Returns
| Type | Description |
|---|---|
| TX |
getOffsetY()
Gets a data offset by Y axis of the Surface.
Declaration
public final TY getOffsetY()
Returns
| Type | Description |
|---|---|
| TY |
getOffsetZ()
Gets a data offset by Z axis of the Surface.
Declaration
public final TZ getOffsetZ()
Returns
| Type | Description |
|---|---|
| TZ |
getUSize()
Gets number of U segments of the 2D grid
Declaration
public final int getUSize()
Returns
| Type | Description |
|---|---|
| int |
getVSize()
Gets number of V segments of the 2D grid
Declaration
public final int getVSize()
Returns
| Type | Description |
|---|---|
| int |
internalUpdateXyzCachedValues(DoubleValues cachedXValues, DoubleValues cachedYValues, DoubleValues cachedZValues)
Updates specified DoubleValues instances with latest data
Declaration
protected abstract void internalUpdateXyzCachedValues(DoubleValues cachedXValues, DoubleValues cachedYValues, DoubleValues cachedZValues)
Parameters
| Type | Name | Description |
|---|---|---|
| DoubleValues | cachedXValues | The DoubleValues for storing cached xValues |
| DoubleValues | cachedYValues | The DoubleValues for storing cached yValues |
| DoubleValues | cachedZValues | The DoubleValues for storing cached zValues |
setOffsetX(TX offsetX)
Sets a data offset by X axis of the Surface.
Declaration
public final void setOffsetX(TX offsetX)
Parameters
| Type | Name | Description |
|---|---|---|
| TX | offsetX | The new offsetX |
setOffsetY(TY offsetY)
Sets a data offset by Y axis of the Surface.
Declaration
public final void setOffsetY(TY offsetY)
Parameters
| Type | Name | Description |
|---|---|---|
| TY | offsetY | The new offsetY |
setOffsetZ(TZ offsetZ)
Sets a data offset by Z axis of the Surface.
Declaration
public final void setOffsetZ(TZ offsetZ)
Parameters
| Type | Name | Description |
|---|---|---|
| TZ | offsetZ | The new offsetZ |
toXyzDoubleValues(DoubleValues xValues, DoubleValues yValues, DoubleValues zValues)
Updates specified values with values provided by this IXyzDataSeries3DValues instance
Declaration
public final void toXyzDoubleValues(DoubleValues xValues, DoubleValues yValues, DoubleValues zValues)
Parameters
| Type | Name | Description |
|---|---|---|
| DoubleValues | xValues | |
| DoubleValues | yValues | |
| DoubleValues | zValues |
tryUpdateCachedValues()
Tries to update cached #cachedXValues, #cachedYValues and #cachedZValues. If #isCachedValuesDirty flag is true updates cached value, otherwise does nothing
Declaration
protected final void tryUpdateCachedValues()
updateXRange(IRange<TX> xRange)
Sets the total extents of the IDataSeries3D in the X direction.
Declaration
protected void updateXRange(IRange<TX> xRange)
Parameters
| Type | Name | Description |
|---|---|---|
| IRange<TX> | xRange |
Overrides
updateYRange(IRange<TY> yRange)
Sets the total extents of the IDataSeries3D in the Y direction.
Declaration
protected void updateYRange(IRange<TY> yRange)
Parameters
| Type | Name | Description |
|---|---|---|
| IRange<TY> | yRange |
Overrides
updateZRange(IRange<TZ> zRange)
Sets the total extents of the IDataSeries3D in the Z direction.
Declaration
protected void updateZRange(IRange<TZ> zRange)
Parameters
| Type | Name | Description |
|---|---|---|
| IRange<TZ> | zRange |