Returns a Cartesian Location with a "total position" equal to specified X, Y, Z, Yaw, Pitch, and Roll coordinates.
...Location.XYZValue(x,y,z,yaw,pitch,roll)
Prerequisites
None
Parameters
x
An optional numeric expression that specifies the X-axis displacement. If this value is not specified, a default value of 0 is assumed.
y
An optional numeric expression that specifies the Y-axis displacement. If this value is not specified, a default value of 0 is assumed.
z
An optional numeric expression that specifies the Z-axis displacement. If this value is not specified, a default value of 0 is assumed.
yaw
An optional numeric expression that specifies the Yaw angle rotation. If this value is not specified, a default value of 0 is assumed.
pitch
An optional numeric expression that specifies the Pitch angle rotation. If this value is not specified, a default value of 0 is assumed.
roll
An optional numeric expression that specifies the Roll angle rotation. If this value is not specified, a default value of 0 is assumed.
Remarks
The XYZValue method computes and returns a Cartesian Location Object that has a "total position" value whose displacement and orientation is equivalent to that specified by the x, y, z, yaw, pitch, and roll arguments. This method is provided as a convenience for constructing Location expressions. If you wish to set the PosWrtRef value of a Cartesian Location Object equal to a set of displacement and orientation values, it is more efficient to utilize the XYZ method instead of XYZValue. The table below describes the data returned in the Location Object.
| Property | Returned Location Object value |
|---|---|
|
Type |
Cartesian Location |
|
PosWrtRef |
Set equal to the displacement and orientation defined by x, y, z, yaw, pitch, and roll arguments. |
|
RefFrame |
Always Null |
|
ZClearance |
1.0e32 to indicate not initialized |
|
All other properties |
Always zeroed. |
Examples
Dim loc1 As Location ' Locations default to Cartesian
loc1.PosWrtRef = Location.XYZValue(10,20,30,0,180,25)
' Equivalent to "loc1.XYZ(10,20,30,0,180,25)"
See Also