SCIRenderableSeriesBase Class Reference

Class provides base functions for all renderable series. More...

#import <SCIRenderableSeriesBase.h>

Inheritance diagram for SCIRenderableSeriesBase:
<SCIRenderableSeriesProtocol> <SCIThemeableProtocol> <SCIDrawableProtocol> SCIBaseColumnRenderableSeries SCIBaseMountainRenderableSeries SCIBubbleRenderableSeries SCICustomRenderableSeries SCIFastBandRenderableSeries SCIFastCandlestickRenderableSeries SCIFastErrorBarsRenderableSeries SCIFastFixedErrorBarsRenderableSeries SCIFastImpulseRenderableSeries SCIFastLineRenderableSeries SCIFastOhlcRenderableSeries SCIFastUniformHeatmapRenderableSeries SCIOhlcRenderableSeriesBase SCIStackedSeriesCollectionBase SCIXyScatterRenderableSeries

Instance Methods

(BOOL) - isValidForDrawing
 If method returns false renderable series is not valid for drawing. More...
 
(float) - getDatapointWidthFrom:Amount:Calculator:WidthFraction:
 Returns data point width in pixels @discussion For internal use. More...
 
(void) - internalDrawWithContext:WithData:
 Method that implements renderable series drawing. More...
 
(void) - iterationInRenderPassData:withBlock:
 Method that iterates through data points @discussion For internal use @params renderPassData SCIRenderPassData contains all data required for drawing. More...
 
- Instance Methods inherited from <SCIRenderableSeriesProtocol>
(void) - addAnimation:
 The SCIRenderableSeriesProtocol class' property. More...
 
(void) - removeAnimation:
 Remove animation from queue, All animations automatically are removed from queue when they are finished, only repeatable animations are left. More...
 
(BOOL) - isValidForUpdate
 Checks whether this series is valid for update. More...
 
- Instance Methods inherited from <SCIDrawableProtocol>
(void) - onDrawAnimationWithContext:
 
(void) - onDrawWithContext:WithData:
 
(void) - prepareForDrawing
 
- Instance Methods inherited from <SCIThemeableProtocol>
(void) - applyThemeProvider:
 Applies specified theme to current instance. More...
 

Protected Attributes

id< SCIPointSeriesProtocol_previousPointSeries
 
SCIAnimationsController_animationsController
 
SCIDataSeriesObserver_dataSeriesObserver
 

Detailed Description

Class provides base functions for all renderable series.

See also
SCIRenderableSeriesProtocol

Method Documentation

◆ getDatapointWidthFrom:Amount:Calculator:WidthFraction:()

- (float) getDatapointWidthFrom: (id< SCIPointSeriesProtocol >)  pointSeries
Amount: (int)  barsAmount
Calculator: (id< SCICoordinateCalculatorProtocol >)  xCalc
WidthFraction: (double)  widthFraction 

Returns data point width in pixels @discussion For internal use.

Has value for charts like candlestick or columns. Method is called during series drawing @discussion All data for this method acquired from currentRenderPassData @params pointSeries SCIPointSeries data points after resampling, which is used in drawing loop @params barsAmount int amount of data points in current viewport @params xCalc SCICoordinateCalculator that converts data values to screen coordinates @params widthFraction double value from 0 to 1, relative size of data points where 0 is zero width, and 1 is no gaps between data points

Returns
float data point width in pixels
See also
SCIPointSeriesProtocol
SCICoordinateCalculator

◆ internalDrawWithContext:WithData:()

- (void) internalDrawWithContext: (id< SCIRenderContext2DProtocol >)  renderContext
WithData: (id< SCIRenderPassDataProtocol >)  renderPassData 

Method that implements renderable series drawing.

@discussion For internal use. Method is called during render loop, at the beginning of renderable series drawing @params renderContext SCIRenderContext2D openGL drawing context where renderable series should be drawn @params renderPassData SCIRenderPassData contains all data required for drawing. Usually it is equal to "currentRenderPassData"

See also
SCIRenderContext2DProtocol
SCIRenderPassDataProtocol

Implemented in SCICustomRenderableSeries.

◆ isValidForDrawing()

- (BOOL) isValidForDrawing

If method returns false renderable series is not valid for drawing.

◆ iterationInRenderPassData:withBlock:()

- (void) iterationInRenderPassData: (id< SCIRenderPassDataProtocol >)  renderPassData
withBlock: (IterationPassDataHandler handler 

Method that iterates through data points @discussion For internal use @params renderPassData SCIRenderPassData contains all data required for drawing.

Usually it is equal to "currentRenderPassData" @params handler IterationPassDataHandler action block that is called for every data point

See also
SCIRenderPassData
IterationPassDataHandler

Field Documentation

◆ _animationsController

- (SCIAnimationsController*) _animationsController
protected

◆ _dataSeriesObserver

- (SCIDataSeriesObserver*) _dataSeriesObserver
protected

◆ _previousPointSeries

- (id<SCIPointSeriesProtocol>) _previousPointSeries
protected

The documentation for this class was generated from the following file: