Difference between revisions of "API Panel.Position.Camera.GetTarget"
(XML import of API auto-gen) |
(XML import) |
||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Gets a handle to the target camera position | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Position|Position]] | ||
| + | ::[[API Panel.Position.Camera|Camera]] | ||
| + | :::[[API Panel.Position.Camera|GetTarget]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''This function has no parameters'' | ''This function has no parameters'' | ||
| − | |||
| − | |||
| − | + | ==Return value== | |
| + | [[Variable Types|HANDLE]] | ||
| − | + | Returns the handle to the target camera position | |
| − | |||
| − | ===Examples | + | |
| − | + | ==Detailed description== | |
| + | This gets the position of the target of the camera - this is the point the camera appears to be looking at, and the point that the camera eye will rotate around in normal operation. The camera is always that of the first view of the [[System Panel]]. No other camera position can be manipulated with this API. | ||
| + | |||
| + | |||
| + | The cameras target is always orientated looking ''away from'' the eye in Z along a ray perpendicular to the ''target plane'' (also known as the object plane). This is the same orientation in the position returned by [[API Panel.Position.Camera.GetEye|GetEye]]. | ||
| + | [[File:Gen Camera.svg|250px|thumb|none|Parts of the camera]] | ||
| + | |||
| + | |||
| + | The coordinates and rotation are variable depending on the position of the camera, but the scale is unused and set to (1,1,1) for the resultant position. This position is compatible with any of the [[API Panel.Position|Position]] API calls. | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
| − | * Add to a calculation icon: result = ::Panel.Position.Camera.GetTarget() | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Camera.GetTarget()</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets a handle to the target camera position
Contents
Parameters
This function has no parameters
Return value
Returns the handle to the target camera position
Detailed description
This gets the position of the target of the camera - this is the point the camera appears to be looking at, and the point that the camera eye will rotate around in normal operation. The camera is always that of the first view of the System Panel. No other camera position can be manipulated with this API.
The cameras target is always orientated looking away from the eye in Z along a ray perpendicular to the target plane (also known as the object plane). This is the same orientation in the position returned by GetEye.
The coordinates and rotation are variable depending on the position of the camera, but the scale is unused and set to (1,1,1) for the resultant position. This position is compatible with any of the Position API calls.
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Panel.Position.Camera.GetTarget()
No additional examples
