Class AxisBase3D<T>

Defines a base functionality for 3D Axes used throughout SciChart

Inheritance

java.lang.Object

AxisCore

AxisBase3D<T>

Implements

IAxis3D

Inherited Members

AxisCore.animateVisibleRangeTo(IRange,long)

AxisCore.applyThemeProvider(IThemeProvider)

AxisCore.attachTo(IServiceContainer)

AxisCore.coerceVisibleRange(IRange<T>)

AxisCore.decrementSuspend()

AxisCore.detach()

AxisCore.formatCursorText(Comparable)

AxisCore.formatText(Comparable)

AxisCore.fromDouble(double)

AxisCore.getAutoRange()

AxisCore.getAutoTicks()

AxisCore.getAxisBandsStyle()

AxisCore.getAxisBorderStyle()

AxisCore.getAxisId()

AxisCore.getAxisParamsLock()

AxisCore.getAxisTitle()

AxisCore.getCoordinate(Comparable)

AxisCore.getCursorTextFormatting()

AxisCore.getDataRange()

AxisCore.getDataRange(boolean)

AxisCore.getDataValue(float)

AxisCore.getDefaultNonZeroRange()

AxisCore.getDrawLabels()

AxisCore.getDrawMajorBands()

AxisCore.getDrawMajorGridLines()

AxisCore.getDrawMajorTicks()

AxisCore.getDrawMinorGridLines()

AxisCore.getDrawMinorTicks()

AxisCore.getFlipCoordinates()

AxisCore.getGrowBy()

AxisCore.getIsSuspended()

AxisCore.getLabelProvider()

AxisCore.getMajorDelta()

AxisCore.getMajorGridLineStyle()

AxisCore.getMajorTickLineLength()

AxisCore.getMajorTickLineStyle()

AxisCore.getMaxAutoTicks()

AxisCore.getMaximumRange()

AxisCore.getMaximumRange(boolean)

AxisCore.getMaximumZoomConstrain()

AxisCore.getMinimalZoomConstrain()

AxisCore.getMinorDelta()

AxisCore.getMinorGridLineStyle()

AxisCore.getMinorTickLineLength()

AxisCore.getMinorTickLineStyle()

AxisCore.getMinorsPerMajor()

AxisCore.getServices()

AxisCore.getTextFormatting()

AxisCore.getTickCoordinatesProvider()

AxisCore.getTickProvider()

AxisCore.getType()

AxisCore.getUpdateSuspenderCount()

AxisCore.getVisibility()

AxisCore.getVisibleRange()

AxisCore.getVisibleRangeAnimator()

AxisCore.getVisibleRangeLimit()

AxisCore.getVisibleRangeLimitMode()

AxisCore.getVisibleRangeType()

AxisCore.getZoomConstrainType()

AxisCore.hasDefaultVisibleRange()

AxisCore.hasValidVisibleRange()

AxisCore.invalidateElement()

AxisCore.invalidateElement(boolean)

AxisCore.isAttached()

AxisCore.isValidRange(IRange)

AxisCore.isValidVisibleRange(IRange)

AxisCore.isZoomConstrainSatisfied(IRange<T>)

AxisCore.onDataRangeChanged()

AxisCore.onVisibilityChanged(int)

AxisCore.onVisibleRangeChanged(IRange,IRange,boolean)

AxisCore.recreateCalculator()

AxisCore.resumeUpdates(IUpdateSuspender)

AxisCore.setAutoRange(AutoRange)

AxisCore.setAutoTicks(boolean)

AxisCore.setAxisBandsStyle(BrushStyle)

AxisCore.setAxisBorderStyle(AxisBorderStyle)

AxisCore.setAxisId(String)

AxisCore.setAxisTitle(CharSequence)

AxisCore.setCursorTextFormatting(String)

AxisCore.setDataRangeChangeListener(DataRangeChangeListener)

AxisCore.setDrawLabels(boolean)

AxisCore.setDrawMajorBands(boolean)

AxisCore.setDrawMajorGridLines(boolean)

AxisCore.setDrawMajorTicks(boolean)

AxisCore.setDrawMinorGridLines(boolean)

AxisCore.setDrawMinorTicks(boolean)

AxisCore.setFlipCoordinates(boolean)

AxisCore.setGrowBy(IRange<Double>)

AxisCore.setLabelProvider(labelProviders.ILabelProvider)

AxisCore.setMajorDelta(Comparable)

AxisCore.setMajorGridLineStyle(PenStyle)

AxisCore.setMajorTickLineLength(float)

AxisCore.setMajorTickLineStyle(PenStyle)

AxisCore.setMaxAutoTicks(int)

AxisCore.setMaximumZoomConstrain(Comparable)

AxisCore.setMinimalZoomConstrain(Comparable)

AxisCore.setMinorDelta(Comparable)

AxisCore.setMinorGridLineStyle(PenStyle)

AxisCore.setMinorTickLineLength(float)

AxisCore.setMinorTickLineStyle(PenStyle)

AxisCore.setMinorsPerMajor(int)

AxisCore.setTextFormatting(String)

AxisCore.setTickCoordinatesProvider(tickCoordinatesProviders.ITickCoordinatesProvider)

AxisCore.setTickProvider(tickProviders.ITickProvider)

AxisCore.setVisibility(int)

AxisCore.setVisibleRange(IRange)

AxisCore.setVisibleRangeAnimator(rangeAnimators.IVisibleRangeAnimator)

AxisCore.setVisibleRangeChangeListener(VisibleRangeChangeListener)

AxisCore.setVisibleRangeLimit(IRange)

AxisCore.setVisibleRangeLimitMode(RangeClipMode)

AxisCore.suspendUpdates()

AxisCore.toDouble(Comparable)

AxisCore.tryApplyVisibleRangeLimitTo(IRange<T>)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Namespace:

Assembly: .dll

Syntax

public abstract class AxisBase3D<T> extends AxisCore<T> implements IAxis3D

Type Parameters

Name	Description
T

Constructors

AxisBase3D(IRange<T> defaultNonZeroRange)

Creates a new instance of AxisBase3D class

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

Type	Description
boolean

textColorProperty

Declaration

protected final SmartPropertyInteger textColorProperty

Field Value

Type	Description
SmartPropertyInteger

textFontProperty

Declaration

protected final SmartProperty<String> textFontProperty

Field Value

Type	Description
SmartProperty<String>

textSizeProperty

Declaration

protected final SmartPropertyFloat textSizeProperty

Field Value

Type	Description
SmartPropertyFloat

Methods

applyThemeProvider(IThemeProvider themeProvider)

Declaration

public void applyThemeProvider(IThemeProvider themeProvider)

Parameters

Type	Name	Description
IThemeProvider	themeProvider

Overrides

AxisCore<T>.applyThemeProvider(IThemeProvider themeProvider)

attachTo(IServiceContainer services)

Declaration

public void attachTo(IServiceContainer services)

Parameters

Type	Name	Description
IServiceContainer	services

Overrides

AxisCore<T>.attachTo(IServiceContainer services)

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)

Creates new ICoordinateCalculator based on axis params values and double representation of visible range

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

Type	Description
ICoordinateCalculator	New ICoordinateCalculator instance

createCoordinateCalculatorFrom(IRange visibleRange)

Declaration

public final coordinateCalculators.ICoordinateCalculator createCoordinateCalculatorFrom(IRange visibleRange)

Parameters

Type	Name	Description
IRange	visibleRange

Returns

Type	Description
ICoordinateCalculator

detach()

Declaration

public void detach()

Overrides

AxisCore<T>.detach()

getAxisDirection3D()

Gets the axis direction used by this axis

Declaration

public final AxisDirection3D getAxisDirection3D()

Returns

Type	Description
AxisDirection3D

getAxisTitleOffset()

Gets the offset applied to axis title drawn by this axis

Declaration

public final float getAxisTitleOffset()

Returns

Type	Description
float

getAxisViewportDimension()

Declaration

public final int getAxisViewportDimension()

Returns

Type	Description
int

getCurrentCoordinateCalculator()

Declaration

public final coordinateCalculators.ICoordinateCalculator getCurrentCoordinateCalculator()

Returns

Type	Description
ICoordinateCalculator

getDataRange(boolean forceCacheUpdate)

Declaration

public final IRange<T> getDataRange(boolean forceCacheUpdate)

Parameters

Type	Name	Description
boolean	forceCacheUpdate

Returns

Type	Description
IRange<T>

Overrides

AxisCore<T>.getDataRange(boolean forceCacheUpdate)

getMaximumRange(boolean forceCacheUpdate)

Declaration

public final IRange<T> getMaximumRange(boolean forceCacheUpdate)

Parameters

Type	Name	Description
boolean	forceCacheUpdate

Returns

Type	Description
IRange<T>

Overrides

AxisCore<T>.getMaximumRange(boolean forceCacheUpdate)

getNegativeSideClipping()

Gets the clipping for negative axis side

Declaration

public final AxisSideClipping getNegativeSideClipping()

Returns

Type	Description
AxisSideClipping

getParentSurface()

Gets the parent surface that this instance is associated with

Declaration

public final ISciChartSurface3D getParentSurface()

Returns

Type	Description
ISciChartSurface3D

getPlaneBorderColor()

Gets the color of axis plane border

Declaration

public final int getPlaneBorderColor()

Returns

Type	Description
int

getPlaneBorderThickness()

Gets the thickness of axis plane border

Declaration

public final float getPlaneBorderThickness()

Returns

Type	Description
float

getPositiveSideClipping()

Gets the clipping for positive axis side

Declaration

public final AxisSideClipping getPositiveSideClipping()

Returns

Type	Description
AxisSideClipping

getTextColor()

Gets the color of text used by axis

Declaration

public final int getTextColor()

Returns

Type	Description
int

getTextFont()

Gets font used by axis to draw text

Declaration

public final String getTextFont()

Returns

Type	Description
String

getTextSize()

Gets the size of text used by axis

Declaration

public final float getTextSize()

Returns

Type	Description
float

getTickLabelAlignment()

Gets the TextAlignment of tick labels for the axis drawn in the 3D Viewport

Declaration

public final TextAlignment3D getTickLabelAlignment()

Returns

Type	Description
TextAlignment3D

getTickLabelOffset()

Gets the offset applied to tick labels drawn by this axis

Declaration

public final float getTickLabelOffset()

Returns

Type	Description
float

invalidateElement(boolean isAxisDirty)

Declaration

public void invalidateElement(boolean isAxisDirty)

Parameters

Type	Name	Description
boolean	isAxisDirty

Overrides

AxisCore<T>.invalidateElement(boolean isAxisDirty)

onDataRangeChanged()

Declaration

public void onDataRangeChanged()

Overrides

AxisCore<T>.onDataRangeChanged()

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

AxisCore<T>.recreateCalculator()

setAxisDirection3D(AxisDirection3D axisDirection3D)

Sets the axis direction used by this axis

Declaration

public final void setAxisDirection3D(AxisDirection3D axisDirection3D)

Parameters

Type	Name	Description
AxisDirection3D	axisDirection3D

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

Type	Name	Description
AxisSideClipping	negativeSideClipping

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

Type	Name	Description
AxisSideClipping	positiveSideClipping

setRangeCalculationHelper(rangeCalculators.IRangeCalculationHelper3D<T> rangeCalculationHelper)

Sets IRangeCalculationHelper3D instance which will be used for range calculations in this axis

Declaration

protected final void setRangeCalculationHelper(rangeCalculators.IRangeCalculationHelper3D<T> rangeCalculationHelper)

Parameters

Type	Name	Description
IRangeCalculationHelper3D<T>	rangeCalculationHelper	New IRangeCalculationHelper3D instance

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

Type	Name	Description
TextAlignment3D	tickLabelAlignment

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)

Updates the state of this IUpdatable3D before rendering

Declaration

public void update(RenderPassState3D renderPassState)

Parameters

Type	Name	Description
RenderPassState3D	renderPassState

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

public void updateCore()

updateProviders()

Updates axis providers such as ITickProvider, ILabelProvider, ITickCoordinatesProvider

Declaration

protected void updateProviders()

Implements

IAxis3D