Interface IRenderableSeries3D
Defines the interface for all RenderableSeries3D within SciChart.
Implements
Namespace:
Assembly: .dll
Syntax
public interface IRenderableSeries3D extends renderableSeries.IRenderableSeriesCore, IUpdatable3D, IThemeable, ISciChartSurface3DProviderMethods
deselectAll()
Deselects all vertices for this renderable series
Declaration
public abstract void deselectAll()getCurrentRenderPassData()
Returns the current ISeriesRenderPassData3D instance which is used for render pass
Declaration
public abstract renderableSeries.ISeriesRenderPassData3D getCurrentRenderPassData()Returns
| Type | Description |
|---|---|
| renderableSeries.ISeriesRenderPassData3D | The current render pass data |
getDataSeries()
Gets the IDataSeries3D associated with this series
Declaration
public abstract dataSeries.IDataSeries3D getDataSeries()Returns
| Type | Description |
|---|---|
| IDataSeries3D | The current data series |
getDataSeriesLock()
Gets the IReadWriteLock instance to lock data series
Declaration
public abstract IReadWriteLock getDataSeriesLock()Returns
| Type | Description |
|---|---|
| IReadWriteLock | The IReadWriteLock instance to lock data series |
getDiffuseColor()
Gets the material diffuse color
Declaration
public abstract int getDiffuseColor()Returns
| Type | Description |
|---|---|
| int | The diffuse color |
getMetadataProvider()
Gets the IMetadataProvider3D instance associated with this series
Declaration
public abstract renderableSeries.metadataProviders.IMetadataProvider3D getMetadataProvider()Returns
| Type | Description |
|---|---|
| renderableSeries.metadataProviders.IMetadataProvider3D | The current IMetadataProvider3D instance |
getPointMarker()
Gets the BasePointMarker3D for this renderable series
Declaration
public abstract pointMarkers.BasePointMarker3D getPointMarker()Returns
| Type | Description |
|---|---|
| pointMarkers.BasePointMarker3D | The current point marker |
getRenderPassDataLock()
Gets the IReadWriteLock instance to lock render pass data
Declaration
public abstract IReadWriteLock getRenderPassDataLock()Returns
| Type | Description |
|---|---|
| IReadWriteLock | The IReadWriteLock instance to lock render pass data |
getSceneEntity()
Gets the scene entity that represent this RenderableSeries3D. This is the entity which will actually do the drawing in the 3D Viewport.
Declaration
public abstract renderableSeries.BaseRenderableSeriesSceneEntity3D getSceneEntity()Returns
| Type | Description |
|---|---|
| BaseRenderableSeriesSceneEntity3D | The scene entity associated with this RenderableSeries3D |
getSeriesColor()
Gets the color which represents this IRenderableSeries3D instance.
Declaration
public abstract int getSeriesColor()Returns
| Type | Description |
|---|---|
| int | The color which represents this IRenderableSeries3D instance. |
getSeriesInfoProvider()
Gets the ISeriesInfo3DProvider instance associated with this series.
Declaration
public abstract renderableSeries.hitTest.ISeriesInfo3DProvider getSeriesInfoProvider()Returns
| Type | Description |
|---|---|
| renderableSeries.hitTest.ISeriesInfo3DProvider | The current ISeriesInfo3DProvider instance |
getShininess()
Gets a shininees from 0.0f - 1024.0f which defines how much the surface material is shining small values tend to have more shines overall the entire surface, think like rubber higher values will mean more focused shines, like plastic a default value of 64.0 is used
Declaration
public abstract float getShininess()Returns
| Type | Description |
|---|---|
| float | The shininess value |
getSpecularColor()
Gets the material specular color
Declaration
public abstract int getSpecularColor()Returns
| Type | Description |
|---|---|
| int | The specular color |
getSpecularStrength()
Gets a specular strength which defines how bright and visible is the shining spot
Declaration
public abstract float getSpecularStrength()Returns
| Type | Description |
|---|---|
| float | The specular strength |
hasDataSeries()
Gets whether this renderable series has data series to draw
Declaration
public abstract boolean hasDataSeries()Returns
| Type | Description |
|---|---|
| boolean | True if has data series to draw |
hitTest(renderableSeries.hitTest.HitTestInfo3D hitTestResult, float x, float y)
Performs a hit-test at the specific point (x,y coordinate on the parent com.scichart.charting.visuals.IRenderableSeriesArea
Declaration
public abstract void hitTest(renderableSeries.hitTest.HitTestInfo3D hitTestResult, float x, float y)Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeries.hitTest.HitTestInfo3D | hitTestResult | The HitTestInfo3D instance where result of hit-test should be stored |
| float | x | The x coordinate in pixels relative to parent com.scichart.charting.visuals.IRenderableSeriesArea |
| float | y | The y coordinate in pixels relative to parent com.scichart.charting.visuals.IRenderableSeriesArea |
hitTest(renderableSeries.hitTest.HitTestInfo3D hitTestResult, long selectionId)
Performs a hit-test at the specific point (x,y coordinate on the parent com.scichart.charting.visuals.IRenderableSeriesArea
Declaration
public abstract void hitTest(renderableSeries.hitTest.HitTestInfo3D hitTestResult, long selectionId)Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeries.hitTest.HitTestInfo3D | hitTestResult | The HitTestInfo3D instance where result of hit-test should be stored |
| long | selectionId | The identifier - an encoded 32-bit Id which combines vertex and mesh ID |
invalidateMetadata()
Asynchronously requests invalidate of metadata provided by IMetadataProvider3D and then invalidates this renderable series
Declaration
public abstract void invalidateMetadata()performSelection(boolean isSelected, renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)
Try to set selection for vertex using hit test results for this renderable series
Declaration
public abstract void performSelection(boolean isSelected, renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)Parameters
| Type | Name | Description |
|---|---|---|
| boolean | isSelected | The selection flag |
| renderableSeries.hitTest.HitTestInfo3D | hitTestInfo3D | The hit test results to use to perform selection |
performSelection(renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)
Try to switch selection (e.g. from selected to unselected and vice versa) for vertex using hit test results for this renderable series
Declaration
public abstract void performSelection(renderableSeries.hitTest.HitTestInfo3D hitTestInfo3D)Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeries.hitTest.HitTestInfo3D | hitTestInfo3D | The hit test results to use to perform selection |
setDataSeries(dataSeries.IDataSeries3D dataSeries)
Sets the IDataSeries3D associated with this series
Declaration
public abstract void setDataSeries(dataSeries.IDataSeries3D dataSeries)Parameters
| Type | Name | Description |
|---|---|---|
| IDataSeries3D | dataSeries | New data series |
setDiffuseColor(int diffuseColor)
Sets the material diffuse color
Declaration
public abstract void setDiffuseColor(int diffuseColor)Parameters
| Type | Name | Description |
|---|---|---|
| int | diffuseColor | The new diffuse color |
setMetadataProvider(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)
Set the IMetadataProvider3D instance associated with this series
Declaration
public abstract void setMetadataProvider(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeries.metadataProviders.IMetadataProvider3D | metadataProvider | The new IMetadataProvider3D instance |
setPointMarker(pointMarkers.BasePointMarker3D pointMarker)
Sets the BasePointMarker3D for this renderable series
Declaration
public abstract void setPointMarker(pointMarkers.BasePointMarker3D pointMarker)Parameters
| Type | Name | Description |
|---|---|---|
| pointMarkers.BasePointMarker3D | pointMarker | New point marker |
setSeriesInfoProvider(renderableSeries.hitTest.ISeriesInfo3DProvider seriesInfoProvider)
Sets the ISeriesInfo3DProvider instance associated with this series.
Declaration
public abstract void setSeriesInfoProvider(renderableSeries.hitTest.ISeriesInfo3DProvider seriesInfoProvider)Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeries.hitTest.ISeriesInfo3DProvider | seriesInfoProvider | New ISeriesInfo3DProvider instance |
setShininess(float shininess)
Sets a shininees from 0.0f - 1024.0f which defines how much the surface material is shining small values tend to have more shines overall the entire surface, think like rubber higher values will mean more focused shines, like plastic a default value of 64.0 is used
Declaration
public abstract void setShininess(float shininess)Parameters
| Type | Name | Description |
|---|---|---|
| float | shininess | The new shininess value |
setSpecularColor(int specularColor)
Sets the material specular color
Declaration
public abstract void setSpecularColor(int specularColor)Parameters
| Type | Name | Description |
|---|---|---|
| int | specularColor | The new specular color |
setSpecularStrength(float specularStrength)
Sets a specular strength which defines how bright and visible is the shining spot
Declaration
public abstract void setSpecularStrength(float specularStrength)Parameters
| Type | Name | Description |
|---|---|---|
| float | specularStrength | The new specular strength |
updateRenderPassData(IAxis3D xAxis, IAxis3D yAxis, IAxis3D zAxis, RenderPassState3D renderPassState)
Called during render pass and updates current render pass data
Declaration
public abstract void updateRenderPassData(IAxis3D xAxis, IAxis3D yAxis, IAxis3D zAxis, RenderPassState3D renderPassState)Parameters
| Type | Name | Description |
|---|---|---|
| IAxis3D | xAxis | The XAxis instance that this IRenderableSeries3D is associated with |
| IAxis3D | yAxis | The YAxis instance that this IRenderableSeries3D is associated with |
| IAxis3D | zAxis | The ZAxis instance that this IRenderableSeries3D is associated with |
| RenderPassState3D | renderPassState | The RenderPassState3D used in current render pass |