GLG Toolkit, JavaScript Library  Version 4.1
 All Classes Namespaces Functions Variables Enumerations Enumerator
GlgPoint Class Reference

Detailed Description

Defines an XYZ point in 3D space or an RGB color. New GlgPoint instances can be created using the CreateGlgPoint method.

Public Member Functions

void CopyFrom (GlgPoint point)
 
boolean Equals (GlgPoint point)
 

Static Public Member Functions

static GlgPoint CopyGlgPoint (GlgPoint point)
 
static GlgPoint CreateGlgPoint (double x, double y, double z)
 
static GlgPoint CreateGlgPointFromPoint (GlgPoint point)
 

Public Attributes

double x
 
double y
 
double z
 

Member Function Documentation

void CopyFrom ( GlgPoint  point)

Copies values from another GlgPoint to this point.

Parameters
pointA point to copy values from.
static GlgPoint CopyGlgPoint ( GlgPoint  point)
static

Copy constructor. Copies an instance of a GlgPoint. The static method is invoked on the GLG Toolkit handle obtaned via a "new GlgToolkit()" call at the application start-up.

Parameters
pointA point to copy values from. If the parameter is null (or not supplied), a new GlgPoint object will not be created and null will be returned.
Returns
A new instance of GlgPoint, or null if no point to copy was supplied.
static GlgPoint CreateGlgPoint ( double  x,
double  y,
double  z 
)
static

Constructor. Creates an instance of GlgPoint. The static method is invoked on the GLG Toolkit handle obtaned via a "new GlgToolkit()" call at the application start-up.

Parameters
xX value
yY value
zZ value
Returns
A new instance of GlgPoint.
static GlgPoint CreateGlgPointFromPoint ( GlgPoint  point)
static

Copy constructor. Copies an instance of a GlgPoint. The static method is invoked on the GLG Toolkit handle obtaned via a "new GlgToolkit()" call at the application start-up.

Parameters
pointAn optional point to copy values from. If this parameter is not supplied or null, the new point's values will be set to 0.
Returns
A new instance of GlgPoint.
boolean Equals ( GlgPoint  point)

Checks if two points are equal.

Parameters
pointA point to compare this point with.
Returns
true if the point has the same x, y and z coordinates as this point.

Member Data Documentation

double x

X or R value.

double y

Y or G value.

double z

Z or B value.