Difference between revisions of "API Panel.Position.Camera.Spin"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
wiki page name
+
<sidebar>API Contents</sidebar>
 
Rotates the camera along its view axis
 
Rotates the camera along its view axis
  
 +
<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|Spin]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|FLOAT]] Degrees''
+
[[Variable Types|FLOAT]] ''Degrees''
 
:Number of degrees to spin in the Z axis
 
:Number of degrees to spin in the Z axis
  
''[[Variable types|BOOL]] Animate''
+
[[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===
 
''No additional information''
 
  
===Examples===
+
==Detailed description==
====Calling in a calculation====
+
This will rotate the camera along its viewing axis, maintaining the eye and target coordinates but altering the cameras perception of ''up'' by a rotation of ''Degrees''.
* Add to a calculation icon: ::Panel.Position.Camera.Spin(degrees, true)
+
 
 +
 
 +
==Examples==
 +
===Calling in a calculation===
 +
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Camera.Spin(degrees, true)</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Rotates the camera along its view axis

Class hierarchy

Panel

Position
Camera
Spin

Parameters

FLOAT Degrees

Number of degrees to spin in the Z axis

BOOL Animate

True to animate movement from the current position


Return value

This call does not return a value


Detailed description

This will rotate the camera along its viewing axis, maintaining the eye and target coordinates but altering the cameras perception of up by a rotation of Degrees.


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Panel.Position.Camera.Spin(degrees, true)

No additional examples