Difference between revisions of "API Panel.Position.Camera.SetEye"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (15 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Sets the eye 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|SetEye]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==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|BOOL]] ''Animate'' | |
:True to animate movement from the current position | :True to animate movement from the current position | ||
| − | + | ||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==Detailed description== |
| − | + | This sets the position of the eye whilst maintaining the position of the target point. The ''Eye'' is used to set the coordinates, and establish an ''up-vector'' for orientation (which affects the ''roll'' around the vector from the eye to the target). Scale is ignored. | |
| − | * Add to a calculation icon: ::Panel.Position.Camera.SetEye(eye, true) | + | |
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Camera.SetEye(eye, true)</pre> | ||
| + | |||
| + | ===SetEye=== | ||
| + | |||
| + | Simple example to move the system panel camera on the panel. | ||
| + | |||
| + | {{Fcfile|CameraSetEye.fcfx|CameraSetEye}} | ||
Latest revision as of 14:57, 11 May 2016
<sidebar>API Contents</sidebar> Sets the eye point of the camera
Contents
Parameters
HANDLE Eye
- The position of the eye to set the camera to
BOOL Animate
- True to animate movement from the current position
Return value
This call does not return a value
Detailed description
This sets the position of the eye whilst maintaining the position of the target point. The Eye is used to set the coordinates, and establish an up-vector for orientation (which affects the roll around the vector from the eye to the target). Scale is ignored.
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.Position.Camera.SetEye(eye, true)
SetEye
Simple example to move the system panel camera on the panel.
