API Panel.Position.Camera.SetView: Difference between revisions
XML import |
XML import |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<sidebar>API | <sidebar>API Contents</sidebar> | ||
Sets the eye and target focal point of the camera | Sets the eye and target focal point of the camera | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API | | ====Class hierarchy==== | ||
:[[API Panel| | [[API Panel|Panel]] | ||
::[[API Panel.Position| | :[[API Panel.Position|Position]] | ||
:::[[API Panel.Position.Camera| | ::[[API Panel.Position.Camera|Camera]] | ||
:::[[API Panel.Position.Camera|SetView]] | |||
</div> | </div> | ||
__TOC__ | __TOC__ | ||
==Parameters== | ==Parameters== | ||
[[Variable Types|HANDLE]] ''Eye'' | |||
:The position of the eye to set the camera to | :The position of the eye to set the camera to | ||
[[Variable Types|FLOAT]] ''FocalRange'' | |||
:The distance the target will be from the eye | :The distance the target will be from the eye | ||
[[Variable Types|BOOL]] ''Animate'' | |||
:True to animate movement from the current position | :True to animate movement from the current position | ||
==Return value== | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
==Detailed description== | ==Detailed description== | ||
'' | This call is the equivalent of calling both the [[API Panel.Position.Camera.SetEye|SetEye]] and [[API Panel.Position.Camera.SetTarget|SetTarget]] calls. | ||
The ''Eye'' is explicitly defined, and the target is calculated as ''FocalRange'' world-space units along the Z axis of the ''Eye'' position. | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Camera.SetView(eye, focalrange, false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Camera.SetView(eye, focalrange, false)</pre> | ||
''<span style="color:red;">No additional examples</span>'' | |||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets the eye and target focal point of the camera
Parameters
HANDLE Eye
- The position of the eye to set the camera to
FLOAT FocalRange
- The distance the target will be from the eye
BOOL Animate
- True to animate movement from the current position
Return value
This call does not return a value
Detailed description
This call is the equivalent of calling both the SetEye and SetTarget calls.
The Eye is explicitly defined, and the target is calculated as FocalRange world-space units along the Z axis of the Eye position.
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.Position.Camera.SetView(eye, focalrange, false)
No additional examples