Class BaseRenderableSeries3D
Defines the Base class for all RenderableSeries3D within SciChart.
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class BaseRenderableSeries3D extends renderableSeries.RenderableSeriesCore implements renderableSeries.IRenderableSeries3D, dataSeries.IDataSeriesObserver
Constructors
BaseRenderableSeries3D(renderableSeries.ISeriesRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Creates a new instance of BaseRenderableSeries3D class
Declaration
protected BaseRenderableSeries3D(renderableSeries.ISeriesRenderPassData3D currentRenderPassData, renderableSeries.BaseRenderableSeriesSceneEntity3D sceneEntity)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.ISeriesRenderPassData3D | currentRenderPassData | The render pass data instance |
BaseRenderableSeriesSceneEntity3D | sceneEntity | The scene entity associated with this series |
Fields
TAG
Declaration
protected static final String TAG
Field Value
Type | Description |
---|---|
String |
diffuseColorProperty
Declaration
protected final SmartPropertyInteger diffuseColorProperty
Field Value
Type | Description |
---|---|
SmartPropertyInteger |
invalidateMeshCallback
Declaration
protected final renderableSeries.BaseRenderableSeries3D.InvalidateMeshCallback invalidateMeshCallback
Field Value
Type | Description |
---|---|
renderableSeries.BaseRenderableSeries3D.InvalidateMeshCallback |
invalidateMetadataCallback
Declaration
protected final renderableSeries.BaseRenderableSeries3D.InvalidateMetadataCallback invalidateMetadataCallback
Field Value
Type | Description |
---|---|
renderableSeries.BaseRenderableSeries3D.InvalidateMetadataCallback |
selectedVertexColorProperty
Declaration
protected final SmartPropertyInteger selectedVertexColorProperty
Field Value
Type | Description |
---|---|
SmartPropertyInteger |
shininessProperty
Declaration
protected final SmartPropertyFloat shininessProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
specularColorProperty
Declaration
protected final SmartPropertyInteger specularColorProperty
Field Value
Type | Description |
---|---|
SmartPropertyInteger |
specularStrengthProperty
Declaration
protected final SmartPropertyFloat specularStrengthProperty
Field Value
Type | Description |
---|---|
SmartPropertyFloat |
Methods
applyThemeProvider(IThemeProvider themeProvider)
Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
Type | Name | Description |
---|---|---|
IThemeProvider | themeProvider |
attachTo(IServiceContainer services)
Declaration
public void attachTo(IServiceContainer services)
Parameters
Type | Name | Description |
---|---|---|
IServiceContainer | services |
Overrides
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 | The RenderPassState3D used in current render pass |
Returns
Type | Description |
---|---|
boolean | True if can update render pass data, otherwise false |
detach()
Declaration
public void detach()
Overrides
getContext()
Declaration
public final Context getContext()
Returns
Type | Description |
---|---|
android.content.Context |
getCurrentRenderPassData()
Returns the current ISeriesRenderPassData3D instance which is used for render pass
Declaration
public final renderableSeries.ISeriesRenderPassData3D getCurrentRenderPassData()
Returns
Type | Description |
---|---|
renderableSeries.ISeriesRenderPassData3D |
getDataSeries()
Gets the IDataSeries3D associated with this series
Declaration
public final dataSeries.IDataSeries3D getDataSeries()
Returns
Type | Description |
---|---|
IDataSeries3D |
getDataSeriesLock()
Gets the IReadWriteLock instance to lock data series
Declaration
public final IReadWriteLock getDataSeriesLock()
Returns
Type | Description |
---|---|
IReadWriteLock |
getDiffuseColor()
Gets the material diffuse color
Declaration
public final int getDiffuseColor()
Returns
Type | Description |
---|---|
int |
getMetadataProvider()
Gets the IMetadataProvider3D instance associated with this series
Declaration
public final renderableSeries.metadataProviders.IMetadataProvider3D getMetadataProvider()
Returns
Type | Description |
---|---|
renderableSeries.metadataProviders.IMetadataProvider3D |
getParentSurface()
Gets the parent surface that this instance is associated with
Declaration
public final ISciChartSurface3D getParentSurface()
Returns
Type | Description |
---|---|
ISciChartSurface3D |
getPointMarker()
Gets the BasePointMarker3D for this renderable series
Declaration
public final pointMarkers.BasePointMarker3D getPointMarker()
Returns
Type | Description |
---|---|
pointMarkers.BasePointMarker3D |
getRenderPassDataLock()
Gets the IReadWriteLock instance to lock render pass data
Declaration
public IReadWriteLock getRenderPassDataLock()
Returns
Type | Description |
---|---|
IReadWriteLock |
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 final renderableSeries.BaseRenderableSeriesSceneEntity3D getSceneEntity()
Returns
Type | Description |
---|---|
BaseRenderableSeriesSceneEntity3D |
getSelectedVertexColor()
Gets the selected color for vertices selected with #performSelection(boolean, HitTestInfo3D)
Declaration
public final int getSelectedVertexColor()
Returns
Type | Description |
---|---|
int | The current selected vertex color |
getSeriesInfoProvider()
Gets the ISeriesInfo3DProvider instance associated with this series.
Declaration
public final renderableSeries.hitTest.ISeriesInfo3DProvider getSeriesInfoProvider()
Returns
Type | Description |
---|---|
renderableSeries.hitTest.ISeriesInfo3DProvider |
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 final float getShininess()
Returns
Type | Description |
---|---|
float |
getSpecularColor()
Gets the material specular color
Declaration
public final int getSpecularColor()
Returns
Type | Description |
---|---|
int |
getSpecularStrength()
Gets a specular strength which defines how bright and visible is the shining spot
Declaration
public final float getSpecularStrength()
Returns
Type | Description |
---|---|
float |
hasDataSeries()
Gets whether this renderable series has data series to draw
Declaration
public final boolean hasDataSeries()
Returns
Type | Description |
---|---|
boolean |
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 final void hitTest(renderableSeries.hitTest.HitTestInfo3D hitTestResult, float x, float y)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.hitTest.HitTestInfo3D | hitTestResult | |
float | x | |
float | y |
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 final void hitTest(renderableSeries.hitTest.HitTestInfo3D hitTestResult, long selectionId)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.hitTest.HitTestInfo3D | hitTestResult | |
long | selectionId |
internalUpdate(RenderPassState3D renderPassState)
Updates this renderable series instances
Declaration
protected void internalUpdate(RenderPassState3D renderPassState)
Parameters
Type | Name | Description |
---|---|---|
RenderPassState3D | renderPassState | The RenderPassState for this render pass |
internalUpdateRenderPassData(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, dataSeries.IDataSeries3D<?,?,?> dataSeries, int updateFlags)
Updates the current render pass data using the data series See Also: com.scichart.charting3d.model.dataSeries.DataSeries3DUpdate
Declaration
protected abstract void internalUpdateRenderPassData(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, dataSeries.IDataSeries3D<?,?,?> dataSeries, int updateFlags)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.ISeriesRenderPassData3D | renderPassDataToUpdate | The render pass data to update |
IDataSeries3D<?,?,?> | dataSeries | The data series associated with this renderable series instance |
int | updateFlags | The update flags used to update render pass data |
internalUpdateRenderPassMetadata(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)
Updates the current render pass data using data provided by #getMetadataProvider()
Declaration
protected abstract void internalUpdateRenderPassMetadata(renderableSeries.ISeriesRenderPassData3D renderPassDataToUpdate, renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.ISeriesRenderPassData3D | renderPassDataToUpdate | The render pass data to update |
renderableSeries.metadataProviders.IMetadataProvider3D | metadataProvider | The metadata provider associated with this renderable series instance |
invalidateElement()
Declaration
public void invalidateElement()
invalidateMeshes()
Asynchronously requests invalidate of meshes provided by BaseRenderableSeries3D#getSceneEntity() and then invalidates this renderable series
Declaration
public final void invalidateMeshes()
invalidateMetadata()
Asynchronously requests invalidate of metadata provided by IMetadataProvider3D and then invalidates this renderable series
Declaration
public final void invalidateMetadata()
isOfValidType(dataSeries.IDataSeries3D dataSeries)
Checks whether the data series instance is valid for this series
Declaration
protected abstract boolean isOfValidType(dataSeries.IDataSeries3D dataSeries)
Parameters
Type | Name | Description |
---|---|---|
IDataSeries3D | dataSeries | The data series instance to check |
Returns
Type | Description |
---|---|
boolean | True if this data series is valid for this series |
isUpdateOfRenderPassDataRequired(coordinateCalculators.ICoordinateCalculator xCoordCalc, coordinateCalculators.ICoordinateCalculator yCoordCalc, coordinateCalculators.ICoordinateCalculator zCoordCalc, int updateFlags)
Checks whether this renderable series need to update its render pass data See Also: com.scichart.charting3d.model.dataSeries.DataSeries3DUpdate
Declaration
protected boolean isUpdateOfRenderPassDataRequired(coordinateCalculators.ICoordinateCalculator xCoordCalc, coordinateCalculators.ICoordinateCalculator yCoordCalc, coordinateCalculators.ICoordinateCalculator zCoordCalc, int updateFlags)
Parameters
Type | Name | Description |
---|---|---|
ICoordinateCalculator | xCoordCalc | The current coordinate calculator for XAxis |
ICoordinateCalculator | yCoordCalc | The current coordinate calculator for YAxis |
ICoordinateCalculator | zCoordCalc | The current coordinate calculator for ZAxis |
int | updateFlags | The update flags used to update render pass data |
Returns
Type | Description |
---|---|
boolean | If true update is required and |
isValidForDrawing()
Declaration
public boolean isValidForDrawing()
Returns
Type | Description |
---|---|
boolean |
isValidForUpdate()
Declaration
public boolean isValidForUpdate()
Returns
Type | Description |
---|---|
boolean |
onDataSeriesChanged(dataSeries.IDataSeriesCore dataSeries, int dataSeriesUpdate)
Declaration
public void onDataSeriesChanged(dataSeries.IDataSeriesCore dataSeries, int dataSeriesUpdate)
Parameters
Type | Name | Description |
---|---|---|
IDataSeriesCore | dataSeries | |
int | dataSeriesUpdate |
setDataSeries(dataSeries.IDataSeries3D dataSeries)
Sets the IDataSeries3D associated with this series
Declaration
public final void setDataSeries(dataSeries.IDataSeries3D dataSeries)
Parameters
Type | Name | Description |
---|---|---|
IDataSeries3D | dataSeries |
setDiffuseColor(int diffuseColor)
Sets the material diffuse color
Declaration
public final void setDiffuseColor(int diffuseColor)
Parameters
Type | Name | Description |
---|---|---|
int | diffuseColor |
setMetadataProvider(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)
Set the IMetadataProvider3D instance associated with this series
Declaration
public final void setMetadataProvider(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.metadataProviders.IMetadataProvider3D | metadataProvider |
setPointMarker(pointMarkers.BasePointMarker3D pointMarker)
Sets the BasePointMarker3D for this renderable series
Declaration
public final void setPointMarker(pointMarkers.BasePointMarker3D pointMarker)
Parameters
Type | Name | Description |
---|---|---|
pointMarkers.BasePointMarker3D | pointMarker |
setSelectedVertexColor(int selectedVertexColor)
Sets the selected color for vertices selected with #performSelection(boolean, HitTestInfo3D)
Declaration
public final void setSelectedVertexColor(int selectedVertexColor)
Parameters
Type | Name | Description |
---|---|---|
int | selectedVertexColor | The new selected vertex color |
setSeriesInfoProvider(renderableSeries.hitTest.ISeriesInfo3DProvider seriesInfoProvider)
Sets the ISeriesInfo3DProvider instance associated with this series.
Declaration
public final void setSeriesInfoProvider(renderableSeries.hitTest.ISeriesInfo3DProvider seriesInfoProvider)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.hitTest.ISeriesInfo3DProvider | seriesInfoProvider |
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 final void setShininess(float shininess)
Parameters
Type | Name | Description |
---|---|---|
float | shininess |
setSpecularColor(int specularColor)
Sets the material specular color
Declaration
public final void setSpecularColor(int specularColor)
Parameters
Type | Name | Description |
---|---|---|
int | specularColor |
setSpecularStrength(float specularStrength)
Sets a specular strength which defines how bright and visible is the shining spot
Declaration
public final void setSpecularStrength(float specularStrength)
Parameters
Type | Name | Description |
---|---|---|
float | specularStrength |
update(RenderPassState3D renderPassState)
Updates the state of this IUpdatable3D before rendering
Declaration
public final void update(RenderPassState3D renderPassState)
Parameters
Type | Name | Description |
---|---|---|
RenderPassState3D | renderPassState |
updateFillMetadata(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider, IntegerValues fillColorsToUpdate, int defaultFill, int pointsCount)
Declaration
protected static void updateFillMetadata(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider, IntegerValues fillColorsToUpdate, int defaultFill, int pointsCount)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.metadataProviders.IMetadataProvider3D | metadataProvider | |
IntegerValues | fillColorsToUpdate | |
int | defaultFill | |
int | pointsCount |
updateMeshColors(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider, IntegerValues meshColorsToUpdate)
Declaration
protected static void updateMeshColors(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider, IntegerValues meshColorsToUpdate)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.metadataProviders.IMetadataProvider3D | metadataProvider | |
IntegerValues | meshColorsToUpdate |
updatePointMetadata(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider, IntegerValues pointColorsToUpdate, FloatValues pointScalesToUpdate, int defaultColor, float defaultScale, int pointsCount)
Declaration
protected static void updatePointMetadata(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider, IntegerValues pointColorsToUpdate, FloatValues pointScalesToUpdate, int defaultColor, float defaultScale, int pointsCount)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.metadataProviders.IMetadataProvider3D | metadataProvider | |
IntegerValues | pointColorsToUpdate | |
FloatValues | pointScalesToUpdate | |
int | defaultColor | |
float | defaultScale | |
int | pointsCount |
updateRenderPassData(IAxis3D xAxis, IAxis3D yAxis, IAxis3D zAxis, RenderPassState3D renderPassState)
Called during render pass and updates current render pass data
Declaration
public final void updateRenderPassData(IAxis3D xAxis, IAxis3D yAxis, IAxis3D zAxis, RenderPassState3D renderPassState)
Parameters
Type | Name | Description |
---|---|---|
IAxis3D | xAxis | |
IAxis3D | yAxis | |
IAxis3D | zAxis | |
RenderPassState3D | renderPassState |
updateStrokeMetadata(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider, IntegerValues strokeColorsToUpdate, int defaultStroke, int pointsCount)
Declaration
protected static void updateStrokeMetadata(renderableSeries.metadataProviders.IMetadataProvider3D metadataProvider, IntegerValues strokeColorsToUpdate, int defaultStroke, int pointsCount)
Parameters
Type | Name | Description |
---|---|---|
renderableSeries.metadataProviders.IMetadataProvider3D | metadataProvider | |
IntegerValues | strokeColorsToUpdate | |
int | defaultStroke | |
int | pointsCount |