Difference between revisions of "API Panel.Position.Camera.SetView"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (5 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 | ||
| Line 12: | Line 12: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[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 | + | [[Variable Types|FLOAT]] ''FocalRange'' |
:The distance the target will be from the eye | :The distance the target will be from the eye | ||
| − | [[Variable | + | [[Variable Types|BOOL]] ''Animate'' |
:True to animate movement from the current position | :True to animate movement from the current position | ||
| + | |||
==Return value== | ==Return value== | ||
| Line 26: | Line 27: | ||
==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. | ||
| Line 33: | Line 37: | ||
* 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 | + | ''<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
Contents
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
