Sparksee  5.2.0
STSNodeExport Class Reference

Stores the node exporting values. More...

Inheritance diagram for STSNodeExport:
Inheritance graph
Collaboration diagram for STSNodeExport:
Collaboration graph

Instance Methods

(id) - init
 Creates a new instance.
 
(void) - setDefaults
 Sets to default values.
 
(NSString *) - getLabel
 Gets the node label.
 
(void) - setLabel:
 Sets the node label.
 
(enum STSNodeShape) - getShape
 Gets the node shape.
 
(void) - setShape:
 Sets the node shape.
 
(int) - getColorRGB
 Gets the node color.
 
(void) - setColorRGB:
 Sets the node color.
 
(int) - getLabelColorRGB
 Gets the node label color.
 
(void) - setLabelColorRGB:
 Sets the node label color.
 
(int) - getHeight
 Gets the node height.
 
(void) - setHeight:
 Sets the node height.
 
(int) - getWidth
 Gets the node width.
 
(void) - setWidth:
 Gets the node width.
 
(BOOL) - isFit
 Gets whether the node size is fitted to the label or not.
 
(void) - setFit:
 Sets the node fit property.
 
(int) - getFontSize
 Gets the node label font size.
 
(void) - setFontSize:
 Sets the node label font size.
 
(void) - getColorRed:green:blue:alpha:
 Get the node color separated in RGBA.
 
(void) - setColorRed:green:blue:alpha:
 Set the node color with separated RGBA components.
 
(void) - getLabelColorRed:green:blue:alpha:
 Get the node label color separated in RGBA.
 
(void) - setLabelColorRed:green:blue:alpha:
 Set the node label color with separated RGBA components.
 

Detailed Description

Stores the node exporting values.

When 'fit' is set to TRUE, then 'height' and 'width' will be ignored.

Some properties may be ignored depending on the exportation type.

Default values are:

Label: "" (empty string).

Shape: Box.

Color: 10863606 (0xa5c3f6).

Label color: 0 (Ox000000, Black).

Height: 25px.

Width: 25px.

Fit: TRUE.

Font size: 10.

Author
Sparsity Technologies http://www.sparsity-technologies.com

Method Documentation

- (void) getColorRed: (double *)  red
green: (double *)  green
blue: (double *)  blue
alpha: (double *)  alpha 

Get the node color separated in RGBA.

Parameters
red[out] The red color component ([0..1]).
green[out] The green color component ([0..1]).
blue[out] The blue color component ([0..1]).
alpha[out] The alpha component ([0..1]).
- (int) getColorRGB

Gets the node color.

Returns
The node color.
- (int) getFontSize

Gets the node label font size.

Returns
The node label font size.
- (int) getHeight

Gets the node height.

Returns
The node height in pixels.
- (NSString*) getLabel

Gets the node label.

Returns
The node label.
- (void) getLabelColorRed: (double *)  red
green: (double *)  green
blue: (double *)  blue
alpha: (double *)  alpha 

Get the node label color separated in RGBA.

Parameters
red[out] The red color component ([0..1]).
green[out] The green color component ([0..1]).
blue[out] The blue color component ([0..1]).
alpha[out] The alpha component ([0..1]).
- (int) getLabelColorRGB

Gets the node label color.

Returns
The node label color.
- (enum STSNodeShape) getShape

Gets the node shape.

Returns
The node shape.
- (int) getWidth

Gets the node width.

Returns
The node width in pixels.
- (BOOL) isFit

Gets whether the node size is fitted to the label or not.

Returns
If TRUE, then the node size is fitted to the label, otherwise the size is fixed with the values of 'height' and 'width'.
- (void) setColorRed: (double)  red
green: (double)  green
blue: (double)  blue
alpha: (double)  alpha 

Set the node color with separated RGBA components.

Parameters
red[in] The red color component ([0..1]).
green[in] The green color component ([0..1]).
blue[in] The blue color component ([0..1]).
alpha[in] The alpha component ([0..1]).
- (void) setColorRGB: (int)  color

Sets the node color.

Parameters
colorThe node color.
- (void) setFit: (BOOL)  fit

Sets the node fit property.

Parameters
fit[in] If TRUE, then the node size is fitted to the label ('height' and 'width' will be ignored), otherwise the size is fixed with the values of 'height' and 'width'.
- (void) setFontSize: (int)  size

Sets the node label font size.

Parameters
size[in] The node label font size.
- (void) setHeight: (int)  height

Sets the node height.

Parameters
height[in] The node height in pixels.
- (void) setLabel: (NSString *)  label

Sets the node label.

Parameters
label[in] The node label.
- (void) setLabelColorRed: (double)  red
green: (double)  green
blue: (double)  blue
alpha: (double)  alpha 

Set the node label color with separated RGBA components.

Parameters
red[in] The red color component ([0..1]).
green[in] The green color component ([0..1]).
blue[in] The blue color component ([0..1]).
alpha[in] The alpha component ([0..1]).
- (void) setLabelColorRGB: (int)  color

Sets the node label color.

Parameters
color[in] The node label color.
- (void) setShape: (enum STSNodeShape)  shape

Sets the node shape.

Parameters
shape[in] The node shape.
- (void) setWidth: (int)  width

Gets the node width.

Parameters
widthThe node width in pixels.

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