TransferNode Class Reference

Representation of a node object to represent within the TransferPanel. More...

#import <TransferNode.h>

List of all members.

Public Member Functions
(id)	- initWithColor:intensity:opacity:x:y:
	Initialize a TransferNode.
(id)	- initWithCoder:
	Initialize a TransferNode for decoding with a NSCoder.
(void)	- encodeWithCoder:
	Encode all attributes of the node.
(BOOL)	- isEqualToPoint:
	Compares the reciever to another point.
(NSColor *)	- invertedNodeColor
	Calculate the inverted NSColor of the node.
(float)	- getRed
	Get the red compontent of the node color.
(float)	- getGreen
	Get the green compontent of the node color.
(float)	- getBlue
	Get the blue compontent of the node color.
(float)	- getAlpha
	Get the alpha compontent of the node color.
Properties
NSColor *	nodeColor
float	intensity
float	opacity
int	x
int	y

---

Detailed Description

Representation of a node object to represent within the TransferPanel.

It has a fill color, intensity, opacity, x-coordinate and y-coordinate.

---

Member Function Documentation

- (void) encodeWithCoder:

(NSCoder *)

coder

Encode all attributes of the node.

Parameters:

coder

The NSCoder for encoding the attributes

- (float) getAlpha

Get the alpha compontent of the node color.

Returns:

A float value between 0.0 and 1.0

- (float) getBlue

Get the blue compontent of the node color.

Returns:

A float value between 0.0 and 1.0

- (float) getGreen

Get the green compontent of the node color.

Returns:

A float value between 0.0 and 1.0

- (float) getRed

Get the red compontent of the node color.

Returns:

A float value between 0.0 and 1.0

- (id) initWithCoder:

(NSCoder *)

coder

Initialize a TransferNode for decoding with a NSCoder.

Parameters:

coder

The NSCoder to decode the object attributes

Returns:

A pointer to the object

- (id) initWithColor:		(NSColor *)	color
intensity:		(float)	aIntensity
opacity:		(float)	aOpacity
x:		(int)	aX
y:		(int)	aY

Initialize a TransferNode.

Parameters:

color	The fill color of the node
aIntensity	The intensity of the node (Intensity is calculated throw x / width of the TransferPanel)
aOpacity	The intensity of the node (Intensity is calculated throw x / width of the TransferPanel)
aX	The x-coordinate of the node
aY	The y-coordinate of the node

Returns:

A pointer to the object

- (NSColor *) invertedNodeColor

Calculate the inverted NSColor of the node.

Returns:

A NSColor object which represents the invertred node color

- (BOOL) isEqualToPoint:

(NSPoint)

otherPoint

Compares the reciever to another point.

The comparision takes a certain threshold into account (kMinNodeDistance)

Parameters:

otherPoint

The NSPoint to be compared to the reciever

Returns:

YES if the points are equal or NO

---

Property Documentation

- (float) intensity [read, write, assign]

- (NSColor *) nodeColor [read, write, retain]

- (float) opacity [read, write, assign]

- (int) x [read, write, assign]

- (int) y [read, write, assign]

---

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

• TransferNode.h
• TransferNode.m