Class SurfaceMeshRenderableSeries3D
Provides SurfaceMesh series rendering
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class SurfaceMeshRenderableSeries3D extends renderableSeries.ContourMeshRenderableSeries3DBase
Constructors
SurfaceMeshRenderableSeries3D()
Creates a new instance of SurfaceMeshRenderableSeries3D class
Declaration
public SurfaceMeshRenderableSeries3D()
SurfaceMeshRenderableSeries3D(renderableSeries.surfaceMesh.SurfaceMeshRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Creates a new instance of SurfaceMeshRenderableSeries3D class
Declaration
protected SurfaceMeshRenderableSeries3D(renderableSeries.surfaceMesh.SurfaceMeshRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.surfaceMesh.SurfaceMeshRenderPassData3D | currentRenderPassData | The render pass data instance |
BaseRenderableSeriesSceneEntity3D | sceneEntity | The scene entity to use for rendering |
Fields
drawSkirtProperty
Declaration
protected final SmartPropertyBoolean drawSkirtProperty
Field Value
Type | Description |
---|---|
SmartPropertyBoolean |
heightScaleFactorProperty
Declaration
protected final SmartPropertyFloat heightScaleFactorProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
maximumProperty
Declaration
protected final SmartPropertyDouble maximumProperty
Field Value
Type | Description |
---|---|
SmartPropertyDouble |
meshResolutionProperty
Declaration
protected final SmartProperty<renderableSeries.surfaceMesh.MeshResolution> meshResolutionProperty
Field Value
Type | Description |
---|---|
SmartProperty<MeshResolution> |
minimumProperty
Declaration
protected final SmartPropertyDouble minimumProperty
Field Value
Type | Description |
---|---|
SmartPropertyDouble |
yOffsetProperty
Declaration
protected final SmartPropertyFloat yOffsetProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
Methods
<TX,TY,TZ>updateGridRenderPassData3D(renderableSeries.surfaceMesh.SurfaceMeshRenderPassData3D surfaceMeshRenderPassData3D, dataSeriesIGridDataSeries3DValues<TX,TY,TZ> xyzDataSeries3DValues)
Declaration
protected static void <TX,TY,TZ>updateGridRenderPassData3D(renderableSeries.surfaceMesh.SurfaceMeshRenderPassData3D surfaceMeshRenderPassData3D, dataSeriesIGridDataSeries3DValues<TX,TY,TZ> xyzDataSeries3DValues)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.surfaceMesh.SurfaceMeshRenderPassData3D | surfaceMeshRenderPassData3D | |
IGridDataSeries3DValues<TX,TY,TZ> | xyzDataSeries3DValues |
getDrawSkirt()
Gets whether to draw the skirt (geometry from the edges of the surface mesh to the zero line in Y)
Declaration
public final boolean getDrawSkirt()
Returns
Type | Description |
---|---|
boolean | The current draw skirt value |
getHeightScaleFactor()
Gets the height scale factor. Default is 1.0f. Value of 0.0f will render a flat Uniform Surface Mesh. Value of 1.0f will use the scaling of the chart's YAxis
Declaration
public final float getHeightScaleFactor()
Returns
Type | Description |
---|---|
float | The current height scale factor |
getMaximum()
Gets value which corresponds to max color
Declaration
public final double getMaximum()
Returns
Type | Description |
---|---|
double | The current maximum value |
getMeshResolution()
Gets the mesh resolution. By default for each point in the data series, there will be one vertex in the resulting mesh. To increase the resolution, use MeshResolution#x2 or MeshResolution#x4
Declaration
public final renderableSeries.surfaceMesh.MeshResolution getMeshResolution()
Returns
Type | Description |
---|---|
renderableSeries.surfaceMesh.MeshResolution | The current mesh resolution |
getMinimum()
Gets value which corresponds to min color
Declaration
public final double getMinimum()
Returns
Type | Description |
---|---|
double | The current minimum value |
getYOffset()
Gets a Y-Offset in World Coordinates. This offset will change the base position of the SurfaceMeshRenderableSeries3D on the chart's YAxis
Declaration
public final float getYOffset()
Returns
Type | Description |
---|---|
float | The current Y offset |
internalUpdateRenderPassData(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, dataSeries.IDataSeries3D<?,?,?> dataSeries, int updateFlags)
Updates the current render pass data using the data series
Declaration
protected void internalUpdateRenderPassData(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, dataSeries.IDataSeries3D<?,?,?> dataSeries, int updateFlags)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.ISeriesRenderPassData3D | renderPassDataToUpdate | |
IDataSeries3D<?,?,?> | dataSeries | |
int | updateFlags |
Overrides
internalUpdateRenderPassMetadata(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)
Updates the current render pass data using data provided by #getMetadataProvider()
Declaration
protected void internalUpdateRenderPassMetadata(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.ISeriesRenderPassData3D | renderPassDataToUpdate | |
renderableSeries.metadataProviders.IMetadataProvider3D | metadataProvider |
Overrides
isOfValidType(dataSeries.IDataSeries3D dataSeries)
Checks whether the data series instance is valid for this series
Declaration
protected boolean isOfValidType(dataSeries.IDataSeries3D dataSeries)
Parameters
Type | Name | Description |
---|---|---|
IDataSeries3D | dataSeries |
Returns
Type | Description |
---|---|
boolean |
Overrides
setDrawSkirt(boolean drawSkirt)
Sets whether to draw the skirt (geometry from the edges of the surface mesh to the zero line in Y)
Declaration
public final void setDrawSkirt(boolean drawSkirt)
Parameters
Type | Name | Description |
---|---|---|
boolean | drawSkirt | The new draw skirt value |
setHeightScaleFactor(float heightScaleFactor)
Sets the height scale factor. Default is 1.0f. Value of 0.0f will render a flat Uniform Surface Mesh. Value of 1.0f will use the scaling of the chart's YAxis
Declaration
public final void setHeightScaleFactor(float heightScaleFactor)
Parameters
Type | Name | Description |
---|---|---|
float | heightScaleFactor | The new height scale factor |
setMaximum(double maximum)
Sets value which corresponds to max color
Declaration
public final void setMaximum(double maximum)
Parameters
Type | Name | Description |
---|---|---|
double | maximum | The new maximum value |
setMeshResolution(renderableSeries.surfaceMesh.MeshResolution meshResolution)
Sets the mesh resolution. By default for each point in the data series, there will be one vertex in the resulting mesh. To increase the resolution, use MeshResolution#x2 or MeshResolution#x4
Declaration
public final void setMeshResolution(renderableSeries.surfaceMesh.MeshResolution meshResolution)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.surfaceMesh.MeshResolution | meshResolution | The new mesh resolution |
setMinimum(double minimum)
Sets value which corresponds to min color
Declaration
public final void setMinimum(double minimum)
Parameters
Type | Name | Description |
---|---|---|
double | minimum | The new minimum value |
setYOffset(float yOffset)
Sets a Y-Offset in World Coordinates. This offset will change the base position of the SurfaceMeshRenderableSeries3D on the chart's YAxis
Declaration
public final void setYOffset(float yOffset)
Parameters
Type | Name | Description |
---|---|---|
float | yOffset | The new Y offset |