OGLPlot3DUniform
int OGLPlot3DUniform (int panelHandle, int OGLControlId, const void *arrayOfZValues, int numberOfXPoints, int numberOfYPoints, int dataType, double xGain, double xOffset, double yGain, double yOffset);
Purpose
Creates a 3D uniform plot on the specified OGL control.
![]() |
Note The plot will not be displayed until the next call to OGLRefreshGraph even if the the plot is not set to be invisible. |
Parameters
Input | ||||||||||||||||||
Name | Type | Description | ||||||||||||||||
panelHandle | int | The specifier for a particular panel that is currently in memory. This handle will have been returned by the LoadPanel, NewPanel, or DuplicatePanel function. |
||||||||||||||||
OGLControlId | int | The ID returned by OGLNewCtrl or OGLConvertCtrl. | ||||||||||||||||
arrayOfZValues | const void * | The array of z values at various locations of the XY grid. The data type must be one of following types: double-precision float integer short integer character unsigned integer unsigned short integer unsigned character The array should be two a dimensional array of the form zArray[NumYPoints][NumXPoints] Each element of the array is associated with a {x,y} location on the graph. The location associated with element zArray[y][x] is at {x*xGain + xOffset, y*yGain + yOffset} on the graph. |
||||||||||||||||
numberOfXPoints | int | Size of the row dimension of the array. | ||||||||||||||||
numberOfYPoints | int | Size of the column dimension of the array. | ||||||||||||||||
dataType | int | Specifies the data type of the Z Array. Valid Data Types:
|
||||||||||||||||
xGain | double | Specifies the gain to be applied to the x locations implied by zArray x index values. The value of zArray[y][x] is the z value at {x*xGain + xOffset, y*yGain + yOffset} on the graph. The default value is 1.0. |
||||||||||||||||
xOffset | double | Specifies the offset to be applied to the x locations implied by zArray x index values. The value of zArray[y][x] is the z value at {x*xGain + xOffset, y*yGain + yOffset} on the graph. The default value is 0.0. |
||||||||||||||||
yGain | double | Specifies the gain to be applied to the y locations implied by zArray y index values. The value of zArray[y][x] is the z value at {x*xGain + xOffset, y*yGain + yOffset} on the graph. The default value is 1.0. |
||||||||||||||||
yOffset | double | Specifies the offset to be applied to the y locations implied by zArray y index values. The value of zArray[y][x] is the z value at {x*xGain + xOffset, y*yGain + yOffset} on the graph. The default value is 0.0. |
Return Value
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
plotHandle | int | Returns the handle used to specify this plot in subsequent function calls. Negative values indicate that an error occurred.Error Codes
|
Additional Information
Library: OpenGL 3D Plotting Control
Include file: custctrl\cviogl.h
LabWindows/CVI compatibility: LabWindows/CVI 5.0 and later