iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

ISCIRenderableSeries3D

Defines the interface for all RenderableSeries 3D within SciChart.

  • Defines the ISCIDataSeries3D associated with this series.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic)
        id<ISCIDataSeries3D> _Nonnull dataSeries;

    Swift

    var dataSeries: ISCIDataSeries3D { get set }
  • Gets whether this renderable series has data series to draw.

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL hasDataSeries;

    Swift

    var hasDataSeries: Bool { get }
  • Gets the scene entity that represent this RenderableSeries 3D.

    Note

    This is the entity which will actually do the drawing in the 3D Viewport.

    Declaration

    Objective-C

    @property (readonly, nonatomic)
        SCIBaseRenderableSeriesSceneEntity3D *_Nonnull sceneEntity;
  • Gets the current ISCISeriesRenderPassData3D instance which is used for render pass.

    Declaration

    Objective-C

    @property (readonly, nonatomic)
        id<ISCISeriesRenderPassData3D> _Nonnull currentRenderPassData;

    Swift

    var currentRenderPassData: ISCISeriesRenderPassData3D { get }
  • Defines the SCIBasePointMarker3D for this renderable series.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable)
        SCIBasePointMarker3D *pointMarker;

    Swift

    var pointMarker: SCIBasePointMarker3D? { get set }
  • Defines the ISCIMetadataProvider3D instance associated with this series.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) id<ISCIMetadataProvider3D>
        metadataProvider;

    Swift

    var metadataProvider: ISCIMetadataProvider3D? { get set }
  • Defines the ISCISeriesInfo3DProvider instance associated with this series.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) id<ISCISeriesInfo3DProvider>
        seriesInfoProvider;

    Swift

    var seriesInfoProvider: ISCISeriesInfo3DProvider? { get set }
  • Gets the color which represents this ISCIRenderableSeries3D instance.

    Declaration

    Objective-C

    @property (readonly, nonatomic) UIColor *_Nonnull seriesColor;

    Swift

    var seriesColor: UIColor { get }
  • Gets the ISCIReadWriteLock instance to lock data series

    Declaration

    Objective-C

    @property (readonly, nonatomic)
        id<ISCIReadWriteLock> _Nonnull renderPassDataLock;

    Swift

    var renderPassDataLock: ISCIReadWriteLock { get }
  • Gets the ISCIReadWriteLock instance to lock data series

    Declaration

    Objective-C

    @property (readonly, nonatomic) id<ISCIReadWriteLock> _Nonnull dataSeriesLock;

    Swift

    var dataSeriesLock: ISCIReadWriteLock { get }
  • Defines the shinines value in [0.0f - 1024.0f] range which defines how much the surface material is shining. Default value of 64.0 is used.

    Note

    Small values tend to have more shines overall the entire surface, think like rubber higher values will mean more focused shines, like plastic.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float shininess;

    Swift

    var shininess: Float { get set }
  • Defines specular strength which defines how bright and visible is the shining spot.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) float specularStrength;

    Swift

    var specularStrength: Float { get set }
  • Defines the material specular color.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) unsigned int specularColor;

    Swift

    var specularColor: UInt32 { get set }
  • Defines the material diffuse color.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) unsigned int diffuseColor;

    Swift

    var diffuseColor: UInt32 { get set }
  • Defines the selected color for vertices selected with -performSelection:.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) unsigned int selectedVertexColor;

    Swift

    var selectedVertexColor: UInt32 { get set }
  • Performs a hit-test at the specific point (x,y coordinate) on the parent renderableSeries area.

    Declaration

    Objective-C

    - (void)hitTest:(nonnull SCIHitTestInfo3D *)hitTestResult at:(CGPoint)point;

    Swift

    func hitTest(_ hitTestResult: SCIHitTestInfo3D, at point: CGPoint)

    Parameters

    hitTestResult

    The SCIHitTestInfo3D instance where result of hit-test should be stored.

    point

    The x-y coordinates in pixels relative to parent renderableSeries area.

  • Performs a hit-test at the specific point (x,y coordinate) on the parent renderableSeries area.

    Declaration

    Objective-C

    - (void)hitTest:(nonnull SCIHitTestInfo3D *)hitTestResult
          selection:(unsigned long long)selectionID;

    Swift

    func hitTest(_ hitTestResult: SCIHitTestInfo3D, selection selectionID: UInt64)

    Parameters

    hitTestResult

    The SCIHitTestInfo3D instance where result of hit-test should be stored.

    selectionID

    The identifier - an encoded 32-bit Id which combines vertex and mesh ID.

  • Try to switch selection (e.g. from selected to unselected and vice versa) for vertex using hit-test results for this renderable series.

    Declaration

    Objective-C

    - (void)performSelection:(nonnull SCIHitTestInfo3D *)hitTestInfo3D;

    Swift

    func performSelection(_ hitTestInfo3D: SCIHitTestInfo3D)

    Parameters

    hitTestInfo3D

    The hit test results to use to perform selection.

  • Try to set selection for vertex using hit test results for this renderable series.

    Declaration

    Objective-C

    - (void)performSelection:(BOOL)isSelected
             withHitTestInfo:(nonnull SCIHitTestInfo3D *)hitTestInfo3D;

    Swift

    func performSelection(_ isSelected: Bool, with hitTestInfo3D: SCIHitTestInfo3D)

    Parameters

    isSelected

    The selection flag.

    hitTestInfo3D

    The hit test results to use to perform selection.

  • Deselects all vertices for this renderable series.

    Declaration

    Objective-C

    - (void)deselectAll;

    Swift

    func deselectAll()
  • Called during render pass and updates current render pass data.

    Declaration

    Objective-C

    - (void)updateRenderPassDataXAxis:(nonnull id<ISCIAxis3D>)xAxis
                                yAxis:(nonnull id<ISCIAxis3D>)yAxis
                                zAxis:(nonnull id<ISCIAxis3D>)zAxis;

    Parameters

    xAxis

    The XAxis instance that this ISCIRenderableSeries3D is associated with.

    yAxis

    The YAxis instance that this ISCIRenderableSeries3D is associated with.

    zAxis

    The ZAxis instance that this ISCIRenderableSeries3D is associated with.

  • Asynchronously requests invalidate of metadata provided by ISCIMetadataProvider3D and then invalidates this renderable series.

    Declaration

    Objective-C

    - (void)invalidateMetadata;

    Swift

    func invalidateMetadata()