Point Class Reference

A point object represents a point with x, y, Z, and M values. Shapes created by adding point objects to the shape. More...

Collaboration diagram for Point:
Collaboration graph

Public Member Functions

Point Clone ()
 Creates an exact copy of the point. More...
 
string get_ErrorMsg (int ErrorCode)
 Retrieves the error message associated with the specified error code. More...
 
void Set (double newX, double newY, double newZ)
 Sets the X, Y, and Z values of this point. More...
 

Properties

ICallback GlobalCallback [get, set]
 The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications. More...
 
string Key [get, set]
 The key may be used by the programmer to store any string data associated with the object. More...
 
int LastErrorCode [get]
 Retrieves the last error generated in the object. More...
 
double M [get, set]
 Gets or sets the measure value of this point. Measures only apply to shapefiles with measure data. More...
 
double x [get, set]
 Gets or sets the x value of the point. More...
 
double y [get, set]
 Gets or sets the y value of the point. More...
 
double Z [get, set]
 Gets or sets the Z value of this point. More...
 

Detailed Description

A point object represents a point with x, y, Z, and M values. Shapes created by adding point objects to the shape.

Here is a diagram for the Point class.

dot_inline_dotgraph_55.png

Graph description

Examples:
CreatePointShapefile.cs, CreatePolygonShapefile.cs, GenerateLabelsManually.cs, LinePattern.cs, MarkPoints.cs, and PolygonsWithHoles.cs.

Member Function Documentation

◆ Clone()

Point Point.Clone ( )

Creates an exact copy of the point.

Returns
The new point.
New API 4.8:
Added in version 4.8

◆ get_ErrorMsg()

string Point.get_ErrorMsg ( int  ErrorCode)

Retrieves the error message associated with the specified error code.

Parameters
ErrorCodeThe error code for which the error message is required.
Returns
The error message description for the specified error code.
Deprecated:
v 4.9.3 Point class doesn't define any error messages.

◆ Set()

void Point.Set ( double  newX,
double  newY,
double  newZ 
)

Sets the X, Y, and Z values of this point.

Parameters
newXThe new X value.
newYThe new Y value.
newZOptional. The new Z value. Defaults to 0.0 if not specified.

Property Documentation

◆ GlobalCallback

ICallback Point.GlobalCallback
getset

The global callback is the interface used by MapWinGIS to pass progress and error events to interested applications.

Deprecated:
v 4.9.3 Point class doesn't define any callback or error messages.

◆ Key

string Point.Key
getset

The key may be used by the programmer to store any string data associated with the object.

Deprecated:
v 4.9.3 Key string is no longer stored for performance reasons and to spare RAM.

◆ LastErrorCode

int Point.LastErrorCode
get

Retrieves the last error generated in the object.

Deprecated:
v 4.9.3 Point class doesn't define any error messages.

◆ M

double Point.M
getset

Gets or sets the measure value of this point. Measures only apply to shapefiles with measure data.

◆ x

double Point.x
getset

Gets or sets the x value of the point.

Examples:
CreatePolygonShapefile.cs, GenerateLabelsManually.cs, LinePattern.cs, and MarkPoints.cs.

◆ y

double Point.y
getset

Gets or sets the y value of the point.

Examples:
CreatePolygonShapefile.cs, GenerateLabelsManually.cs, LinePattern.cs, and MarkPoints.cs.

◆ Z

double Point.Z
getset

Gets or sets the Z value of this point.