Sets and gets the “position with respect to the reference frame” value of a Cartesian Location Object while ignoring the reference frame.
location_object.PosWrtRef = <specified_location_value>
-or-
...location_object.PosWrtRef
Prerequisites
The location_object must be a Cartesian Location Object.
Parameters
None
Remarks
This property accesses the “position with respect to the reference frame” of a Cartesian Location Object. Normally, the PosWrtRef value is evaluated in combination with the reference frame to compute the “total position” of a Location. However, this property accesses the “position with respect to the reference frame” data ignoring any specified reference frame data.
The PosWrtRef set operation allows a statement to assign a new value to the “position with respect to the reference frame” of the location_object without affecting or considering the value of any reference frame or any other data of the location_object. The new value is set equal to the “total position” of the <specified_location_value> on the right hand side of the equal sign.
The PosWrtRef get operation returns a Cartesian Location Object that contains only the “position with respect to the reference frame” of the location_object with no reference frame or other data. In particular, the value of the returned Object is as follows:
| Property | Returned Location Object value |
|---|---|
|
Type |
Cartesian Location |
|
PosWrtRef |
PosWrtRef of the location_object |
|
RefFrame |
Always NULL |
|
ZClearance |
1.0e32 to indicate not initialized |
|
All other properties |
Always zeroed. |
Examples
Dim loc1 As New Location ' Create new Location set to default values
Dim loc2 As New Location
loc1.ZClearance = 12
loc2.XYZ(10,20,30,0,180,23) ' Define position for loc2
loc1.PosWrtRef = loc2.PosWrtRef ' Use same PosWrtRef for loc1
See Also
Location Class | location_object.Inverse |location_object.Mul |location_object.Pos