Class AxisBase3D<T>
Defines a base functionality for 3D Axes used throughout SciChart
Inheritance
AxisBase3D<T>
Namespace:
Assembly: .dll
Syntax
public abstract class AxisBase3D<T> extends AxisCore<T> implements IAxis3D
Type Parameters
Constructors
AxisBase3D(IRange<T> defaultNonZeroRange)
Declaration
protected AxisBase3D(IRange<T> defaultNonZeroRange)
Parameters
Type |
Name |
Description |
IRange<T> |
defaultNonZeroRange |
The default non zero range which should be used by axis
|
Fields
isProvidersDirty
Declaration
protected volatile boolean isProvidersDirty
Field Value
textColorProperty
Declaration
protected final SmartPropertyInteger textColorProperty
Field Value
textFontProperty
Declaration
protected final SmartProperty<String> textFontProperty
Field Value
textSizeProperty
Declaration
protected final SmartPropertyFloat textSizeProperty
Field Value
Methods
applyThemeProvider(IThemeProvider themeProvider)
Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
Overrides
attachTo(IServiceContainer services)
Declaration
public void attachTo(IServiceContainer services)
Parameters
Overrides
calculateAxisViewportDimension()
Calculates axis viewport dimension in pixels
Declaration
protected int calculateAxisViewportDimension()
Returns
Type |
Description |
int |
Viewport dimension in pixels
|
createCoordinateCalculator(AxisParams axisParams, double visibleRangeMin, double visibleRangeMax)
Declaration
protected coordinateCalculators.ICoordinateCalculator createCoordinateCalculator(AxisParams axisParams, double visibleRangeMin, double visibleRangeMax)
Parameters
Type |
Name |
Description |
AxisParams |
axisParams |
Axis params to create calculator from
|
double |
visibleRangeMin |
The double representation of min value for visible range to create calculator from
|
double |
visibleRangeMax |
The double representation of max value for visible range to create calculator from
|
Returns
createCoordinateCalculatorFrom(IRange visibleRange)
Declaration
public final coordinateCalculators.ICoordinateCalculator createCoordinateCalculatorFrom(IRange visibleRange)
Parameters
Type |
Name |
Description |
IRange |
visibleRange |
|
Returns
detach()
Declaration
Overrides
getAxisDirection3D()
Gets the axis direction used by this axis
Declaration
public final AxisDirection3D getAxisDirection3D()
Returns
getAxisTitleOffset()
Gets the offset applied to axis title drawn by this axis
Declaration
public final float getAxisTitleOffset()
Returns
getAxisViewportDimension()
Declaration
public final int getAxisViewportDimension()
Returns
getCurrentCoordinateCalculator()
Declaration
public final coordinateCalculators.ICoordinateCalculator getCurrentCoordinateCalculator()
Returns
getDataRange(boolean forceCacheUpdate)
Declaration
public final IRange<T> getDataRange(boolean forceCacheUpdate)
Parameters
Type |
Name |
Description |
boolean |
forceCacheUpdate |
|
Returns
Overrides
getMaximumRange(boolean forceCacheUpdate)
Declaration
public final IRange<T> getMaximumRange(boolean forceCacheUpdate)
Parameters
Type |
Name |
Description |
boolean |
forceCacheUpdate |
|
Returns
Overrides
getNegativeSideClipping()
Gets the clipping for negative axis side
Declaration
public final AxisSideClipping getNegativeSideClipping()
Returns
getParentSurface()
Gets the parent surface that this instance is associated with
Declaration
public final ISciChartSurface3D getParentSurface()
Returns
getPlaneBorderColor()
Gets the color of axis plane border
Declaration
public final int getPlaneBorderColor()
Returns
getPlaneBorderThickness()
Gets the thickness of axis plane border
Declaration
public final float getPlaneBorderThickness()
Returns
getPositiveSideClipping()
Gets the clipping for positive axis side
Declaration
public final AxisSideClipping getPositiveSideClipping()
Returns
getTextColor()
Gets the color of text used by axis
Declaration
public final int getTextColor()
Returns
getTextFont()
Gets font used by axis to draw text
Declaration
public final String getTextFont()
Returns
getTextSize()
Gets the size of text used by axis
Declaration
public final float getTextSize()
Returns
getTickLabelAlignment()
Gets the TextAlignment of tick labels for the axis drawn in the 3D Viewport
Declaration
public final TextAlignment3D getTickLabelAlignment()
Returns
getTickLabelOffset()
Gets the offset applied to tick labels drawn by this axis
Declaration
public final float getTickLabelOffset()
Returns
invalidateElement(boolean isAxisDirty)
Declaration
public void invalidateElement(boolean isAxisDirty)
Parameters
Type |
Name |
Description |
boolean |
isAxisDirty |
|
Overrides
onDataRangeChanged()
Declaration
public void onDataRangeChanged()
Overrides
onWorldDimensionsChanged(Vector3 worldDimensions)
Called when observed world dimensions instance has changed.
Declaration
public void onWorldDimensionsChanged(Vector3 worldDimensions)
Parameters
Type |
Name |
Description |
Vector3 |
worldDimensions |
|
recreateCalculator()
Declaration
protected void recreateCalculator()
Overrides
setAxisDirection3D(AxisDirection3D axisDirection3D)
Sets the axis direction used by this axis
Declaration
public final void setAxisDirection3D(AxisDirection3D axisDirection3D)
Parameters
setAxisTitleOffset(float axisTitleOffset)
Sets the offset applied to axis title drawn by this axis
Declaration
public final void setAxisTitleOffset(float axisTitleOffset)
Parameters
Type |
Name |
Description |
float |
axisTitleOffset |
|
setNegativeSideClipping(AxisSideClipping negativeSideClipping)
Sets the clipping for negative axis side
Declaration
public final void setNegativeSideClipping(AxisSideClipping negativeSideClipping)
Parameters
setPlaneBorderColor(int planeBorderColor)
Sets the color of axis plane border
Declaration
public void setPlaneBorderColor(int planeBorderColor)
Parameters
Type |
Name |
Description |
int |
planeBorderColor |
|
setPlaneBorderThickness(float planeBorderThickness)
Sets the thickness of axis plane border
Declaration
public final void setPlaneBorderThickness(float planeBorderThickness)
Parameters
Type |
Name |
Description |
float |
planeBorderThickness |
|
setPositiveSideClipping(AxisSideClipping positiveSideClipping)
Sets the clipping for positive axis side
Declaration
public final void setPositiveSideClipping(AxisSideClipping positiveSideClipping)
Parameters
setRangeCalculationHelper(rangeCalculators.IRangeCalculationHelper3D<T> rangeCalculationHelper)
Declaration
protected final void setRangeCalculationHelper(rangeCalculators.IRangeCalculationHelper3D<T> rangeCalculationHelper)
Parameters
setTextColor(int textColor)
Sets the color of text used by axis
Declaration
public final void setTextColor(int textColor)
Parameters
Type |
Name |
Description |
int |
textColor |
|
setTextFont(String textFont)
Sets font used by axis to draw text
Declaration
public void setTextFont(String textFont)
Parameters
Type |
Name |
Description |
String |
textFont |
|
setTextSize(float textSize)
Sets the size of text used by axis
Declaration
public final void setTextSize(float textSize)
Parameters
Type |
Name |
Description |
float |
textSize |
|
setTickLabelAlignment(TextAlignment3D tickLabelAlignment)
Sets the TextAlignment of tick labels for the axis drawn in the 3D Viewport
Declaration
public final void setTickLabelAlignment(TextAlignment3D tickLabelAlignment)
Parameters
setTickLabelOffset(float tickLabelOffset)
Sets the offset applied to tick labels drawn by this axis
Declaration
public final void setTickLabelOffset(float tickLabelOffset)
Parameters
Type |
Name |
Description |
float |
tickLabelOffset |
|
update(RenderPassState3D renderPassState)
Declaration
public void update(RenderPassState3D renderPassState)
Parameters
updateAxisParams(AxisParams axisParams)
Updates axis params according to current state of axis
Declaration
protected void updateAxisParams(AxisParams axisParams)
Parameters
Type |
Name |
Description |
AxisParams |
axisParams |
Axis params to update
|
updateCore()
Performs core update of axis
(e.g. updates ILabelProvider, ITickProvider, ITickCoordinatesProvider
and other providers which are used by axis )
Declaration
updateProviders()
Updates axis providers such as ITickProvider, ILabelProvider, ITickCoordinatesProvider
Declaration
protected void updateProviders()
Implements