Class FreeSurfaceRenderableSeries3D
Provides Surface series rendering
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class FreeSurfaceRenderableSeries3D extends renderableSeries.ContourMeshRenderableSeries3DBase
Constructors
FreeSurfaceRenderableSeries3D()
Creates a new instance of FreeSurfaceRenderableSeries3D class
Declaration
public FreeSurfaceRenderableSeries3D()
FreeSurfaceRenderableSeries3D(renderableSeries.freeSurface.FreeSurfaceRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Creates a new instance of FreeSurfaceRenderableSeries3D class
Declaration
protected FreeSurfaceRenderableSeries3D(renderableSeries.freeSurface.FreeSurfaceRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.freeSurface.FreeSurfaceRenderPassData3D | currentRenderPassData | The render pass data instance |
BaseRenderableSeriesSceneEntity3D | sceneEntity | The scene entity associated with this series |
Fields
contourAxisProperty
Declaration
protected final SmartProperty<AxisDirection3D> contourAxisProperty
Field Value
Type | Description |
---|---|
SmartProperty<AxisDirection3D> |
drawBackSideProperty
Declaration
protected final SmartPropertyBoolean drawBackSideProperty
Field Value
Type | Description |
---|---|
SmartPropertyBoolean |
paletteAxialFactorProperty
Declaration
protected final SmartProperty<Vector3> paletteAxialFactorProperty
Field Value
Type | Description |
---|---|
SmartProperty<Vector3> |
paletteAzimuthalFactorProperty
Declaration
protected final SmartPropertyFloat paletteAzimuthalFactorProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
paletteMaximumProperty
Declaration
protected final SmartProperty<Vector3> paletteMaximumProperty
Field Value
Type | Description |
---|---|
SmartProperty<Vector3> |
paletteMinMaxModeProperty
Declaration
protected final SmartProperty<renderableSeries.freeSurface.FreeSurfacePaletteMinMaxMode> paletteMinMaxModeProperty
Field Value
Type | Description |
---|---|
SmartProperty<FreeSurfacePaletteMinMaxMode> |
paletteMinimumProperty
Declaration
protected final SmartProperty<Vector3> paletteMinimumProperty
Field Value
Type | Description |
---|---|
SmartProperty<Vector3> |
palettePolarFactorProperty
Declaration
protected final SmartPropertyFloat palettePolarFactorProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
paletteRadialFactorProperty
Declaration
protected final SmartPropertyFloat paletteRadialFactorProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
Methods
getContourAxis()
Gets a value dermining by which 3D axis the contour is calculated
Declaration
public final AxisDirection3D getContourAxis()
Returns
Type | Description |
---|---|
AxisDirection3D | The contour axis |
getDrawBackSide()
Gets value determining if back side of chart should be drawn.
Declaration
public final boolean getDrawBackSide()
Returns
Type | Description |
---|---|
boolean | The current draw back side value |
getPaletteAxialFactor()
Gets palette color intensity in regards to X, Y and Z axis.
Declaration
public final Vector3 getPaletteAxialFactor()
Returns
Type | Description |
---|---|
Vector3 | The current palette axial factor value |
getPaletteAzimuthalFactor()
Gets palette color intensity in regards to surface orientation in azimuthal space.
Declaration
public final float getPaletteAzimuthalFactor()
Returns
Type | Description |
---|---|
float | The current palette radial factor value |
getPaletteMaximum()
Gets palette maximum color in regards to X, Y and Z axis
Declaration
public final Vector3 getPaletteMaximum()
Returns
Type | Description |
---|---|
Vector3 | The palette maximum value |
getPaletteMinMaxMode()
Gets the the mode of #getPaletteMaximum() and #getPaletteMinimum() values.
Declaration
public final renderableSeries.freeSurface.FreeSurfacePaletteMinMaxMode getPaletteMinMaxMode()
Returns
Type | Description |
---|---|
renderableSeries.freeSurface.FreeSurfacePaletteMinMaxMode | The palette min max mode |
getPaletteMinimum()
Gets palette minimum color in regards to X, Y and Z axis
Declaration
public final Vector3 getPaletteMinimum()
Returns
Type | Description |
---|---|
Vector3 | The palette minimum |
getPalettePolarFactor()
Gets palette color intensity in regards to surface orientation in polar space.
Declaration
public final float getPalettePolarFactor()
Returns
Type | Description |
---|---|
float | The current palette polar factor value |
getPaletteRadialFactor()
Gets palette color intensity in regards to surface distance from origin.
Declaration
public final float getPaletteRadialFactor()
Returns
Type | Description |
---|---|
float | The current palette radial factor value |
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
setContourAxis(AxisDirection3D contourAxis)
Sets a value dermining by which 3D axis the contour is calculated
Declaration
public final void setContourAxis(AxisDirection3D contourAxis)
Parameters
Type | Name | Description |
---|---|---|
AxisDirection3D | contourAxis | The new contour axis |
setDrawBackSide(boolean drawBackSide)
Sets value determining if back side of chart should be drawn.
Declaration
public final void setDrawBackSide(boolean drawBackSide)
Parameters
Type | Name | Description |
---|---|---|
boolean | drawBackSide | The new draw back side value |
setPaletteAxialFactor(Vector3 paletteAxialFactor)
Sets palette color intensity in regards to X, Y and Z axis.
Declaration
public final void setPaletteAxialFactor(Vector3 paletteAxialFactor)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | paletteAxialFactor | The new palette axial factor value |
setPaletteAzimuthalFactor(float paletteAzimuthalFactor)
Sets palette color intensity in regards to surface orientation in azimuthal space.
Declaration
public final void setPaletteAzimuthalFactor(float paletteAzimuthalFactor)
Parameters
Type | Name | Description |
---|---|---|
float | paletteAzimuthalFactor | The new palette azimuthal factor value |
setPaletteMaximum(Vector3 paletteMaximum)
Sets palette maximum color in regards to X, Y and Z axis
Declaration
public final void setPaletteMaximum(Vector3 paletteMaximum)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | paletteMaximum | The new palette maximum value |
setPaletteMinMaxMode(renderableSeries.freeSurface.FreeSurfacePaletteMinMaxMode paletteMinMaxMode)
Sets the the mode of #getPaletteMaximum() and #getPaletteMinimum() values.
Declaration
public final void setPaletteMinMaxMode(renderableSeries.freeSurface.FreeSurfacePaletteMinMaxMode paletteMinMaxMode)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.freeSurface.FreeSurfacePaletteMinMaxMode | paletteMinMaxMode | The new palette min max mode |
setPaletteMinimum(Vector3 paletteMinimum)
Sets palette minimum color in regards to X, Y and Z axis
Declaration
public final void setPaletteMinimum(Vector3 paletteMinimum)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | paletteMinimum | The new palette minimum value |
setPalettePolarFactor(float palettePolarFactor)
Sets palette color intensity in regards to surface orientation in polar space.
Declaration
public final void setPalettePolarFactor(float palettePolarFactor)
Parameters
Type | Name | Description |
---|---|---|
float | palettePolarFactor | The new palette polar factor value |
setPaletteRadialFactor(float paletteRadialFactor)
Sets palette color intensity in regards to surface distance from origin.
Declaration
public final void setPaletteRadialFactor(float paletteRadialFactor)
Parameters
Type | Name | Description |
---|---|---|
float | paletteRadialFactor | The new palette radial factor value |