API Panel.Position.Camera.SetView: Difference between revisions

← Older edit

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Sets the eye and target focal point of the camera

Class hierarchy

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

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
 Sets the eye and target focal point of the camera
+<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|SetView]]
+</div>
+__TOC__
-===Parameters===
+==Parameters==
-''[[Variable types|HANDLE]] Eye''
+[[Variable Types|HANDLE]] ''Eye''
 :The position of the eye to set the camera to
-''[[Variable types|FLOAT]] FocalRange''
+[[Variable Types|FLOAT]] ''FocalRange''
 :The distance the target will be from the eye
-''[[Variable types|BOOL]] Animate''
+[[Variable Types|BOOL]] ''Animate''
 :True to animate movement from the current position
-===Return value===
+==Return value==
 ''This call does not return a value''
-===Detailed description===
-''No additional information''
-===Examples===
+==Detailed description==
-====Calling in a calculation====
+This call is the equivalent of calling both the [[API Panel.Position.Camera.SetEye|SetEye]] and [[API Panel.Position.Camera.SetTarget|SetTarget]] calls.
-* Add to a calculation icon: ::Panel.Position.Camera.SetView(eye, focalrange, false)
+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: <pre class="brush:[cpp]">::Panel.Position.Camera.SetView(eye, focalrange, false)</pre>
+''<span style="color:red;">No additional examples</span>''

JonnyW (talk | contribs)