| Customize Help
| Save Settings

M3dgraCylinder


Function Map
Syntax
Description
Parameters
- List3dgraId
- ParentLabel
Table: For specifying the parent label
- CreationMode
- XPos1
- YPos1
- ZPos1
- XPos2OrVector
- YPos2OrVector
- ZPos2OrVector
- Radius
Table: For specifying the cylinder graphic's radius
- Length
Table: For specifying to override the default cylinder graphic's length
- ControlFlag
Parameter Associations
Table: For specifying the cylinder graphic
Return value
Compilation information
Synopsis
Add a cylinder graphic to a 3D graphics list.
Syntax
MIL_INT64 M3dgraCylinder(
MIL_ID List3dgraId, //in
MIL_INT64 ParentLabel, //in
MIL_INT64 CreationMode, //in
MIL_DOUBLE XPos1, //in
MIL_DOUBLE YPos1, //in
MIL_DOUBLE ZPos1, //in
MIL_DOUBLE XPos2OrVector, //in
MIL_DOUBLE YPos2OrVector, //in
MIL_DOUBLE ZPos2OrVector, //in
MIL_DOUBLE Radius, //in
MIL_DOUBLE Length, //in
MIL_INT64 ControlFlag //in
)
Description

This function adds a cylinder graphic to the specified 3D graphics list, allowing you to, for example, view the cylinder graphic on a 3D display.

You must specify the label of the 3D graphic, in the 3D graphics list, to use as the parent of the cylinder graphic. When the cylinder graphic is added to the 3D graphics list's tree structure, it is added as a child under the specified parent. If the 3D graphics list is empty, the cylinder graphic's parent must be the root node. All coordinates are expressed in the coordinate system of the cylinder graphic's parent.

The cylinder graphic has its own coordinate system that represents the cylinder graphic's position and orientation with respect to its parent's coordinate system. The origin of the cylinder graphic's coordinate system is the cylinder graphic's start point, and its Z-axis is the cylinder graphic's central axis. You can inquire the cylinder graphic's start point using M3dgraInquire() with M_START_POINT_....

To modify or inquire 3D graphics list settings, use M3dgraControl() or M3dgraInquire(), respectively.

Unlike most other functions that modify a MIL object, you can call this function concurrently from multiple threads on the same MIL 3D graphics list (List3dgraId) without using an M_MUTEX object, as long as all the other parameters of the concurrent calls do not also share data.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
List3dgraId

Specifies the identifier of the 3D graphics list in which to add the cylinder graphic.

ParentLabel

Specifies the label of the parent of the cylinder graphic in the 3D graphics list.

function map For specifying the parent label
Click to summarizeValue Description
Click to summarize M_DEFAULT

Same as M_ROOT_NODE.
Click to summarize M_ROOT_NODE

Specifies the top-most node of the 3D graphics list.
Click to summarize Value >= 0

Specifies the label of the parent of the cylinder graphic in the 3D graphics list. Label 0 is the 3D graphics list's root node.

(summarize)
CreationMode

Specifies how the cylinder graphic is defined.

See the Parameter associations section for possible values that can be specified.

XPos1

Specifies the first parameter used to define the cylinder graphic.

See the Parameter associations section for possible values that can be specified.

YPos1

Specifies the second parameter used to define the cylinder graphic.

See the Parameter associations section for possible values that can be specified.

ZPos1

Specifies the third parameter used to define the cylinder graphic.

See the Parameter associations section for possible values that can be specified.

XPos2OrVector

Specifies the fourth parameter used to define the cylinder graphic.

See the Parameter associations section for possible values that can be specified.

YPos2OrVector

Specifies the fifth parameter used to define the cylinder graphic.

See the Parameter associations section for possible values that can be specified.

ZPos2OrVector

Specifies the sixth parameter used to define the cylinder graphic.

See the Parameter associations section for possible values that can be specified.

Radius

Specifies the cylinder graphic's radius.

function map For specifying the cylinder graphic's radius
Click to summarizeValue Description
Click to summarize Value > 0.0

Specifies the cylinder graphic's radius.
Length

Specifies to override the default cylinder graphic's length.

function map For specifying to override the default cylinder graphic's length
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies the default length defined by the creation mode.
Click to summarize M_INFINITE

Specifies an infinite cylinder graphic. The cylinder graphic's size is determined upon creation, using its 3D graphics list's clipping box.

(summarize)
Click to summarize Value > 0.0

Specifies to override the cylinder graphic's length with a specific value.
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Parameter associations

The table below lists possible values for the CreationMode, XPos1, YPos1, ZPos1, XPos2OrVector, YPos2OrVector, and ZPos2OrVector parameters.

function map For specifying the cylinder graphic
Click to summarizeCreationMode Description
XPos1
YPos1
ZPos1
XPos2OrVector
YPos2OrVector
ZPos2OrVector
Click to summarize M_POINT_AND_VECTOR

Defines the cylinder graphic using a point on the cylinder graphic's central axis and a nonzero vector defining the central axis direction.

By default, the length of the cylinder graphic is finite and is set to the vector's magnitude. The point is at the center of the cylinder graphic's first circular base.

(summarize)
Click to summarize XPos1

Specifies the X-coordinate of the point on the cylinder graphic's central axis.
Click to summarize YPos1

Specifies the Y-coordinate of the point on the cylinder graphic's central axis.
Click to summarize ZPos1

Specifies the Z-coordinate of the point on the cylinder graphic's central axis.
Click to summarize XPos2OrVector

Specifies the X-component of the vector defining the central axis direction.
Click to summarize YPos2OrVector

Specifies the Y-component of the vector defining the central axis direction.
Click to summarize ZPos2OrVector

Specifies the Z-component of the vector defining the central axis direction.
Click to summarize M_TWO_POINTS

Defines the cylinder graphic using any two non-identical points on the cylinder graphic's central axis.

By default, the length of the cylinder graphic is finite and is set to the distance between the two specified points. The first specified point is at the center of the cylinder graphic's first circular base and the second specified point is at the center of the cylinder graphic's second circular base.

(summarize)
Click to summarize XPos1

Specifies the X-coordinate of the first point on the cylinder graphic's central axis.
Click to summarize YPos1

Specifies the Y-coordinate of the first point on the cylinder graphic's central axis.
Click to summarize ZPos1

Specifies the Z-coordinate of the first point on the cylinder graphic's central axis.
Click to summarize XPos2OrVector

Specifies the X-coordinate of the second point on the cylinder graphic's central axis.
Click to summarize YPos2OrVector

Specifies the Y-coordinate of the second point on the cylinder graphic's central axis.
Click to summarize ZPos2OrVector

Specifies the Z-coordinate of the second point on the cylinder graphic's central axis.
Return value
Returns the label of the cylinder graphic added to the 3D graphics list.
Compilation information
Header Include mil.h.
Library Use mil.lib; mil3d.lib.
DLL Requires mil.dll; mil3d.dll.
DEFAULT ROOT NODE DEFAULT INFINITE POINT AND VECTOR TWO POINTS