Class ContourMeshRenderableSeries3DBase

Defines a base class for FreeSurfaceRenderableSeries3D and SurfaceMeshRenderableSeries3D

Inheritance
java.lang.Object
RenderableSeriesCore
renderableSeries.BaseRenderableSeries3D
ContourMeshRenderableSeries3DBase
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class ContourMeshRenderableSeries3DBase extends renderableSeries.BaseRenderableSeries3D

Constructors

ContourMeshRenderableSeries3DBase(renderableSeries.GridXyzRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)

Creates a new instance of ContourMeshRenderableSeries3DBase class

Declaration
protected ContourMeshRenderableSeries3DBase(renderableSeries.GridXyzRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Parameters
Type Name Description
renderableSeries.GridXyzRenderPassData3D currentRenderPassData

The render pass data instance
BaseRenderableSeriesSceneEntity3D sceneEntity

The scene entity associated with this series

Fields

contourIntervalProperty

Declaration
protected final SmartPropertyFloat contourIntervalProperty
Field Value
Type Description
SmartPropertyFloat

contourOffsetProperty

Declaration
protected final SmartPropertyFloat contourOffsetProperty
Field Value
Type Description
SmartPropertyFloat

contourStrokeProperty

Declaration
protected final SmartPropertyInteger contourStrokeProperty
Field Value
Type Description
SmartPropertyInteger

contourStrokeThicknessProperty

Declaration
protected final SmartPropertyFloat contourStrokeThicknessProperty
Field Value
Type Description
SmartPropertyFloat

drawMeshAsProperty

Declaration
protected final SmartProperty<renderableSeriesDrawMeshAs> drawMeshAsProperty
Field Value
Type Description
SmartProperty<DrawMeshAs>

highlightProperty

Declaration
protected final SmartPropertyFloat highlightProperty
Field Value
Type Description
SmartPropertyFloat

lightingFactorProperty

Declaration
protected final SmartPropertyFloat lightingFactorProperty
Field Value
Type Description
SmartPropertyFloat

meshColorPaletteProperty

Declaration
protected final SmartProperty<renderableSeriesMeshColorPalette> meshColorPaletteProperty
Field Value
Type Description
SmartProperty<MeshColorPalette>

meshColorPaletteSize

Declaration
protected final SmartProperty<Size> meshColorPaletteSize
Field Value
Type Description
SmartProperty<Size>

meshPaletteModeProperty

Declaration
protected final SmartProperty<renderableSeriesMeshPaletteMode> meshPaletteModeProperty
Field Value
Type Description
SmartProperty<MeshPaletteMode>

strokeProperty

Declaration
protected final SmartPropertyInteger strokeProperty
Field Value
Type Description
SmartPropertyInteger

strokeThicknessProperty

Declaration
protected final SmartPropertyFloat strokeThicknessProperty
Field Value
Type Description
SmartPropertyFloat

Methods

canUpdateRenderPassData(RenderPassState3D renderPassState)

Checks if current renderable series can update render pass data

Declaration
protected boolean canUpdateRenderPassData(RenderPassState3D renderPassState)
Parameters
Type Name Description
RenderPassState3D renderPassState
Returns
Type Description
boolean
Overrides

deselectAll()

Declaration
public void deselectAll()

getColorMapTexture()

Gets the ColorMapTexture generated when the #setMeshColorPalette(MeshColorPalette) property changes

Declaration
public Texture2D getColorMapTexture()
Returns
Type Description
Texture2D

The texture to use for rendering

getContourInterval()

Gets the contour interval

Declaration
public final float getContourInterval()
Returns
Type Description
float

The contour interval

getContourOffset()

Gets the contour offset

Declaration
public final float getContourOffset()
Returns
Type Description
float

The contour offset

getContourStroke()

Gets the contour color

Declaration
public final int getContourStroke()
Returns
Type Description
int

The contour color

getContourStrokeThickness()

Gets the contour stroke thickness

Declaration
public final float getContourStrokeThickness()
Returns
Type Description
float

The contour stroke thickness

getDrawMeshAs()

Gets how to draw the mesh

Declaration
public final renderableSeriesDrawMeshAs getDrawMeshAs()
Returns
Type Description
renderableSeriesDrawMeshAs

The draw mesh as value

getHighlight()

Gets value in range 0...1 that defines how much the surface is highlighted its in low lit parts.

Declaration
public final float getHighlight()
Returns
Type Description
float

The current highlight

getLightingFactor()

Gets or sets a factor from 0.0f - 1.0f which defines how much lighting is used on cells, 0.0f = no lighting and 1.0f = fully lit

Declaration
public final float getLightingFactor()
Returns
Type Description
float

The current lighting factor

getMeshColorPalette()

Gets the MeshColorPalette which is used to calculate color from data value

Declaration
public final renderableSeriesMeshColorPalette getMeshColorPalette()
Returns
Type Description
renderableSeriesMeshColorPalette

The mesh color palette

getMeshColorPaletteSize()

Gets the Size of the texture to create when the #setMeshColorPalette(MeshColorPalette) property is set

Declaration
public final Size getMeshColorPaletteSize()
Returns
Type Description
Size

The size of mesh color palette texture

getMeshPaletteMode()

Gets the MeshPaletteMode, which defines how to apply the #getMeshColorPalette()

Declaration
public final renderableSeriesMeshPaletteMode getMeshPaletteMode()
Returns
Type Description
renderableSeriesMeshPaletteMode

The current mode

getSeriesColor()

Declaration
public int getSeriesColor()
Returns
Type Description
int

getStroke()

Gets the stroke color of the wireframe lines. Used when #getDrawMeshAs() is WireFrame or SolidWireFrame

Declaration
public final int getStroke()
Returns
Type Description
int

The stroke color

getStrokeThickness()

Gets the stroke thickness to apply to the wireframe. Used when #getDrawMeshAs() is WireFrame or SolidWireFrame

Declaration
public final float getStrokeThickness()
Returns
Type Description
float

The stroke thickness

performSelection(boolean isSelected, renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)

Declaration
public void performSelection(boolean isSelected, renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)
Parameters
Type Name Description
boolean isSelected
renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D

performSelection(renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)

Declaration
public void performSelection(renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)
Parameters
Type Name Description
renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D

setContourInterval(float contourInterval)

Sets the contour interval

Declaration
public final void setContourInterval(float contourInterval)
Parameters
Type Name Description
float contourInterval

The new contour interval

setContourOffset(float contourOffset)

Sets the contour offset

Declaration
public final void setContourOffset(float contourOffset)
Parameters
Type Name Description
float contourOffset

The new contour offset

setContourStroke(int contourStroke)

Sets the contour color

Declaration
public final void setContourStroke(int contourStroke)
Parameters
Type Name Description
int contourStroke

The new contour color

setContourStrokeThickness(float contourStrokeThickness)

Sets the contour stroke thickness

Declaration
public final void setContourStrokeThickness(float contourStrokeThickness)
Parameters
Type Name Description
float contourStrokeThickness

The new contour stroke thickness

setDrawMeshAs(renderableSeriesDrawMeshAs drawMeshAs)

Sets how to draw the mesh

Declaration
public final void setDrawMeshAs(renderableSeriesDrawMeshAs drawMeshAs)
Parameters
Type Name Description
renderableSeriesDrawMeshAs drawMeshAs

The new draw mesh as value

setHighlight(float highlight)

Sets value in range 0...1 that defines how much the surface is highlighted its in low lit parts.

Declaration
public final void setHighlight(float highlight)
Parameters
Type Name Description
float highlight

The new highlight value

setLightingFactor(float lightingFactor)

Sets or sets a factor from 0.0f - 1.0f which defines how much lighting is used on cells, 0.0f = no lighting and 1.0f = fully lit

Declaration
public final void setLightingFactor(float lightingFactor)
Parameters
Type Name Description
float lightingFactor

The new lighting factor

setMeshColorPalette(renderableSeriesMeshColorPalette meshColorPalette)

Sets the MeshColorPalette which is used to calculate color from data value

Declaration
public final void setMeshColorPalette(renderableSeriesMeshColorPalette meshColorPalette)
Parameters
Type Name Description
renderableSeriesMeshColorPalette meshColorPalette

The new mesh color palette

setMeshColorPaletteSize(Size meshColorPaletteSize)

Sets the Size of the texture to create when the #setMeshColorPalette(MeshColorPalette) property is set

Declaration
public final void setMeshColorPaletteSize(Size meshColorPaletteSize)
Parameters
Type Name Description
Size meshColorPaletteSize

The new size of mesh color palette texture

setMeshPaletteMode(renderableSeriesMeshPaletteMode meshPaletteMode)

Sets the MeshPaletteMode, which defines how to apply the #getMeshColorPalette()

Declaration
public final void setMeshPaletteMode(renderableSeriesMeshPaletteMode meshPaletteMode)
Parameters
Type Name Description
renderableSeriesMeshPaletteMode meshPaletteMode

The new mode value

setStroke(int stroke)

Sets the stroke color of the wireframe lines. Used when #getDrawMeshAs() is WireFrame or SolidWireFrame

Declaration
public final void setStroke(int stroke)
Parameters
Type Name Description
int stroke

The new stroke color

setStrokeThickness(float strokeThickness)

Sets the stroke thickness to apply to the wireframe. Used when #getDrawMeshAs() is WireFrame or SolidWireFrame

Declaration
public final void setStrokeThickness(float strokeThickness)
Parameters
Type Name Description
float strokeThickness

The new stroke thickness