ISCIRenderableSeries3D Protocol Reference


                        
                        
                        dataSeries

Defines the ISCIDataSeries3D associated with this series.

Declaration

Objective-C

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

Swift

var dataSeries: any ISCIDataSeries3D { get set }


                        
                        
                        hasDataSeries

Gets whether this renderable series has data series to draw.

Declaration

Objective-C

@property (nonatomic, readonly) BOOL hasDataSeries;

Swift

var hasDataSeries: Bool { get }


                        
                        
                        sceneEntity

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 (nonatomic, readonly) SCIBaseRenderableSeriesSceneEntity3D *_Nonnull sceneEntity;

Swift

var sceneEntity: SCIBaseRenderableSeriesSceneEntity3D<any ISCISeriesRenderPassData3D> { get }


                        
                        
                        currentRenderPassData

Gets the current ISCISeriesRenderPassData3D instance which is used for render pass.

Declaration

Objective-C

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

Swift

var currentRenderPassData: any ISCISeriesRenderPassData3D { get }


                        
                        
                        pointMarker

Defines the SCIBasePointMarker3D for this renderable series.

Declaration

Objective-C

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

Swift

var pointMarker: SCIBasePointMarker3D? { get set }


                        
                        
                        metadataProvider

Defines the ISCIMetadataProvider3D instance associated with this series.

Declaration

Objective-C

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

Swift

var metadataProvider: (any ISCIMetadataProvider3D)? { get set }


                        
                        
                        seriesInfoProvider

Defines the ISCISeriesInfo3DProvider instance associated with this series.

Declaration

Objective-C

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

Swift

var seriesInfoProvider: (any ISCISeriesInfo3DProvider)? { get set }


                        
                        
                        seriesColor

Gets the color which represents this ISCIRenderableSeries3D instance.

Declaration

Objective-C

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

Swift

var seriesColor: UIColor { get }


                        
                        
                        renderPassDataLock

Gets the ISCIReadWriteLock instance to lock data series

Declaration

Objective-C

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

Swift

var renderPassDataLock: any ISCIReadWriteLock { get }


                        
                        
                        dataSeriesLock

Gets the ISCIReadWriteLock instance to lock data series

Declaration

Objective-C

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

Swift

var dataSeriesLock: any ISCIReadWriteLock { get }


                        
                        
                        shininess

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 (nonatomic) float shininess;

Swift

var shininess: Float { get set }


                        
                        
                        specularStrength

Defines specular strength which defines how bright and visible is the shining spot.

Declaration

Objective-C

@property (nonatomic) float specularStrength;

Swift

var specularStrength: Float { get set }


                        
                        
                        specularColor

Defines the material specular color.

Declaration

Objective-C

@property (nonatomic) unsigned int specularColor;

Swift

var specularColor: UInt32 { get set }


                        
                        
                        diffuseColor

Defines the material diffuse color.

Declaration

Objective-C

@property (nonatomic) unsigned int diffuseColor;

Swift

var diffuseColor: UInt32 { get set }


                        
                        
                        selectedVertexColor

Defines the selected color for vertices selected with -performSelection:.

Declaration

Objective-C

@property (nonatomic) unsigned int selectedVertexColor;

Swift

var selectedVertexColor: UInt32 { get set }


                        
                        
                        -hitTest:at:

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.


                        
                        
                        -hitTest:selection:

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.


                        
                        
                        -performSelection:

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.


                        
                        
                        -performSelection:withHitTestInfo:

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.


                        
                        
                        -deselectAll

Deselects all vertices for this renderable series.

Declaration

Objective-C

- (void)deselectAll;

Swift

func deselectAll()


                        
                        
                        -updateRenderPassDataXAxis:yAxis:zAxis:

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;

Swift

func updateRenderPassDataXAxis(_ xAxis: any ISCIAxis3D, yAxis: any ISCIAxis3D, zAxis: any ISCIAxis3D)

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.


                        
                        
                        -invalidateMetadata

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

Declaration

Objective-C

- (void)invalidateMetadata;

Swift

func invalidateMetadata()