ISCIRenderableSeries3D Protocol Reference


                        
                        
                        dataSeries

Defines the ISCIDataSeries3D associated with this series.

Declaration

Objective-C

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


                        
                        
                        hasDataSeries

Gets whether this renderable series has data series to draw.

Declaration

Objective-C

@property (nonatomic, readonly) BOOL hasDataSeries;


                        
                        
                        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;


                        
                        
                        currentRenderPassData

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

Declaration

Objective-C

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


                        
                        
                        pointMarker

Defines the SCIBasePointMarker3D for this renderable series.

Declaration

Objective-C

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


                        
                        
                        metadataProvider

Defines the ISCIMetadataProvider3D instance associated with this series.

Declaration

Objective-C

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


                        
                        
                        seriesInfoProvider

Defines the ISCISeriesInfo3DProvider instance associated with this series.

Declaration

Objective-C

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


                        
                        
                        seriesColor

Gets the color which represents this ISCIRenderableSeries3D instance.

Declaration

Objective-C

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


                        
                        
                        renderPassDataLock

Gets the ISCIReadWriteLock instance to lock data series

Declaration

Objective-C

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


                        
                        
                        dataSeriesLock

Gets the ISCIReadWriteLock instance to lock data series

Declaration

Objective-C

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


                        
                        
                        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;


                        
                        
                        specularStrength

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

Declaration

Objective-C

@property (nonatomic) float specularStrength;


                        
                        
                        specularColor

Defines the material specular color.

Declaration

Objective-C

@property (nonatomic) unsigned int specularColor;


                        
                        
                        diffuseColor

Defines the material diffuse color.

Declaration

Objective-C

@property (nonatomic) unsigned int diffuseColor;


                        
                        
                        selectedVertexColor

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

Declaration

Objective-C

@property (nonatomic) unsigned int selectedVertexColor;


                        
                        
                        -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;

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;

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;

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;

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;


                        
                        
                        -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;

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;