Async3DPick
Return the instance path or position of the central body or object double-clicked with the left mouse button in a 3D window
Syntax
Async3DPick <ScenarioPath> {State} [<Parameter>]
Description
The Async3DPick Connect command allows you to double-click an object or central body with the left mouse button in a 3D window and return the path or position of that object.
- Turn on Asynchronous mode using the ConControl Connect command.
- Send the Async3DPick command.
- The appropriate data, based on the {State} options specified, will be returned.
The Async3DPick command may interrupt normal 3D window pick operations. This command can only be activated if the Enable Selection option is On via the Annotation page of the 3D window's properties. If that option isn't enabled, Connect returns a NACK.
{State} can be:
| {State} | <Parameters> | Description |
|---|---|---|
| Once | [{HitOption} [ValuePair]] | Returns the instance path or position of the next STK object double-clicked, then turns Off. |
| On | [{HitOption} [ValuePair]] | Returns each instance path or position of the object double-clicked until Async3DPick is turned Off. |
| Broadcast | [{HitOption} [ValuePair]] | Returns the next instance path of the object double-clicked to all sockets until the Off command is issued. |
| Off | N/A | Turns Off Async3DPick so that no instance paths or position data is returned. |
Valid values for {HitOption} are described in the following table:
| {HitOption} | Description |
|---|---|
| N/A | If no {HitOption} is specified and you double-click on an object in the 3D window, Connect returns the instance path for that object. If you double-click on terrain or a central body no information is returned. |
| Advanced | If Advanced is specified and you double-clicked an object, terrain or a central body, Connect returns the information on the object. |
| FirstHit | If FirstHit is specified and you double-clicked an object, terrain or a central body, Connect returns information on the closest picked object. |
| AllHits | If AllHits is specified Connect returns information on all picked items in order from closest to farthest away. |
If a {HitOption} is specified and you double-click an STK object, Connect returns "Object <ObjectPath> <VOWindowID>" for most objects. Additional information may be displayed for some objects.
If a {HitOption} is specified and you double-click terrain or the central body, Connect returns "Position <Lat Lon Alt> <VOWindowID>" for that object.
If {HitOption} is FirstHit or AllHits and you double-click a graphics Primitive, Connect returns "PrimitiveID <ID>" for that primitive. For more information on graphics primitives see VO Primitive.
If a {HitOption} is specified you can also include the keyword ValuePair. In this case, Connect returns a user friendly format consisting of keyword-value pairs. For example, if you double-click a great arc vehicle, Connect returns "Object <ObjectPath> Waypoint <Index> VOWindowID <VOWindowID>".
An asynchronous pick only registers in a 3D window if that window's pick is enabled.
Examples
To return all instance paths for objects double-clicked in a VO window:
Return message
A return message similar to the following is sent if Async3DPick is set to On and you double-click on the model for the Perth facility in the 3D window:AGI421003ACK 000056000100010011 ASYNC3DPICK AGI421011ASYNC3DPICK 000026000100000048 /Application/STK/Scenario/Scenario1/Facility/Perth
Examples
To return all instance paths and window id numbers for objects double-clicked in a VO window:
Return message
A return message similar to the following is sent if the above Async3DPick command is sent and you double-click on the model for the Perth facility in the 3D window 1:AGI421003ACK 000056000100010011 ASYNC3DPICK AGI421011ASYNC3DPICK 000032000100000056 Object /Application/STK/Scenario/testAOU/Facility/Perth 1
Examples
To return all instance paths and window id numbers for objects double-clicked in a VO window, in a user-friendly format:
Return message
A return message similar to the following is sent if the above Async3DPick command is sent and you double-click on the model for the facBwLineOfBearing facility in the 3D window 1:AGI421003ACK 000056000100010011 ASYNC3DPICK AGI421011ASYNC3DPICK 000038000100000081 Object /Application/STK/Scenario/testAOU/Facility/facBwLineOfBearing VOWindowID 1
Group membership
This command belongs to the following group(s):
Version
6.1.2