 | CEMAPiGetGrid Method |
Position and size a grid on a map.
Namespace:
Geosoft.Desktop.GXNetX
Assembly:
geosoft.desktop.gxnetx (in geosoft.desktop.gxnetx.dll) Version: 2024.2.0.25
Syntaxpublic int iGetGrid(
string str_val,
int nx,
int ny,
ref double angle,
ref double x1,
ref double y1,
ref double x_len,
ref double y_len
)
public int iGetGrid(
string str_val,
int nx,
int ny,
ref double angle,
ref double x1,
ref double y1,
ref double x_len,
ref double y_len
)
Public Function iGetGrid (
str_val As String,
nx As Integer,
ny As Integer,
ByRef angle As Double,
ByRef x1 As Double,
ByRef y1 As Double,
ByRef x_len As Double,
ByRef y_len As Double
) As Integer
Public Function iGetGrid (
str_val As String,
nx As Integer,
ny As Integer,
ByRef angle As Double,
ByRef x1 As Double,
ByRef y1 As Double,
ByRef x_len As Double,
ByRef y_len As Double
) As Integer
public:
int iGetGrid(
String^ str_val,
int nx,
int ny,
double% angle,
double% x1,
double% y1,
double% x_len,
double% y_len
)
public:
int iGetGrid(
String^ str_val,
int nx,
int ny,
double% angle,
double% x1,
double% y1,
double% x_len,
double% y_len
)
member iGetGrid :
str_val : string *
nx : int *
ny : int *
angle : float byref *
x1 : float byref *
y1 : float byref *
x_len : float byref *
y_len : float byref -> int
member iGetGrid :
str_val : string *
nx : int *
ny : int *
angle : float byref *
x1 : float byref *
y1 : float byref *
x_len : float byref *
y_len : float byref -> int
Parameters
- str_val
- Type: SystemString
User prompt string - nx
- Type: SystemInt32
Number of elements along primary axis to draw. - ny
- Type: SystemInt32
Number of elements along secondary axis to draw. - angle
- Type: SystemDouble
Angle of primary axis in degrees - x1
- Type: SystemDouble
Grid origin X - y1
- Type: SystemDouble
Grid origin Y - x_len
- Type: SystemDouble
Primary axis length - y_len
- Type: SystemDouble
Secondary axis length
Return Value
Type:
Int32
0 if line returned.
1 if user cancelled.
Remarks
If the input angle is <define>rDUMMY</define>, an extra step is inserted
for the user to define the angle by drawing a line
with the mouse.
The output primary axis angle will always be in the
range -90 < angle <= 90. The grid origin is shifted to
whichever corner necessary to make this possible, while keeping
the secondary axis at 90 degrees greater than the primary (
going counter-clockwise).
The coordinates are returned in the current User projection
(See GetUserIPJ_MVIEW and SetUserIPJ_MVIEW.)
See Also