Difference between revisions of "API Panel.Position.Camera.SetTarget"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
|||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | API | + | <sidebar>API Contents</sidebar> |
Sets the target point of the camera | Sets the target 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|SetTarget]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Target'' | |
:The target position to look at | :The target position to look at | ||
| − | + | [[Variable Types|BOOL]] ''UseAxis'' | |
:True to apply the axis to the eye, else just use the coordinates | :True to apply the axis to the eye, else just use the coordinates | ||
| − | + | [[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 target whilst maintaining the position of the eye point. The ''Target'' is used to set the coordinates, and if ''UseAxis'' is true, to establish an ''up-vector'' for orientation (which affects the ''roll'' around the vector from the eye to the target). If ''UseAxis'' is false then the current eye to target vector is used to calculate orientation. Scale is ignored. | |
| − | * Add to a calculation icon: ::Panel.Position.Camera.SetTarget(target, true, false) | + | |
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Camera.SetTarget(target, true, false)</pre> | ||
| + | |||
| + | ===SetTarget=== | ||
| + | |||
| + | Simple example to focus the system panel camera on objects on the panel. | ||
| + | |||
| + | {{Fcfile|CameraSetTarget.fcfx|CameraSetTarget}} | ||
Latest revision as of 14:58, 11 May 2016
<sidebar>API Contents</sidebar> Sets the target point of the camera
Contents
Parameters
HANDLE Target
- The target position to look at
BOOL UseAxis
- True to apply the axis to the eye, else just use the coordinates
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 target whilst maintaining the position of the eye point. The Target is used to set the coordinates, and if UseAxis is true, to establish an up-vector for orientation (which affects the roll around the vector from the eye to the target). If UseAxis is false then the current eye to target vector is used to calculate orientation. Scale is ignored.
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.Position.Camera.SetTarget(target, true, false)
SetTarget
Simple example to focus the system panel camera on objects on the panel.
