Difference between revisions of "LlTargetOmega"

From Second Life Wiki
Jump to: navigation, search
m (Added a few periods where some were missing.)
m (Replaced old <LSL> block with <source lang="lsl2">)
 
(15 intermediate revisions by 4 users not shown)
Line 9: Line 9:
 
|p3_type=float|p3_name=gain|p3_desc=also modulates the final spinrate and disables the rotation behavior if zero
 
|p3_type=float|p3_name=gain|p3_desc=also modulates the final spinrate and disables the rotation behavior if zero
 
|func_footnote
 
|func_footnote
|func_desc=Rotates the object/prim around '''axis''' at '''spinrate''' * [[llVecMag]]('''axis''') in radians per second with strength '''gain'''.
+
|func_desc=Rotates the object/prim around {{LSLP|axis}} at a rate of <code>{{LSLPT|spinrate}} * [[llVecMag]]({{LSLPT|axis}})</code> in radians per second with strength {{LSLP|gain}}.
|examples=<lsl>//rotates the x axis once per second,
+
|examples=<source lang="lsl2">//rotates the x axis once per second,
 
//  rotates the y axis 3 times per second,  
 
//  rotates the y axis 3 times per second,  
 
//  rotates the z axis once every two seconds.
 
//  rotates the z axis once every two seconds.
 
//  combined the rate is about 3.20156 revolutions per second
 
//  combined the rate is about 3.20156 revolutions per second
  
llTargetOmega(<1.0,3.0,0.5>,TWO_PI,1.0);</lsl>
+
llTargetOmega(<1.0,3.0,0.5>,TWO_PI,1.0);</source>
  
<lsl> //Rotates very slowly around a sphere's local X axis .... Good for making a globe that rotates around a tilted axis
+
<source lang="lsl2"> //Rotates very slowly around a sphere's local X axis .... Good for making a globe that rotates around a tilted axis
  
 
default
 
default
Line 25: Line 25:
 
       llTargetOmega(<1.0,0.0,0.0>*llGetRot(),0.1,0.01);
 
       llTargetOmega(<1.0,0.0,0.0>*llGetRot(),0.1,0.01);
 
     }
 
     }
}</lsl>
+
}</source>
<lsl> //Rotates very slowly around a cylinder's local or global Z axis
+
<source lang="lsl2"> //Rotates very slowly around a cylinder's local or global Z axis
 
  // .... Good for making a propeller that rotates regardless of initial orientation.
 
  // .... Good for making a propeller that rotates regardless of initial orientation.
  
Line 35: Line 35:
 
       llTargetOmega(llRot2Up(llGetLocalRot()), PI, 1.0);
 
       llTargetOmega(llRot2Up(llGetLocalRot()), PI, 1.0);
 
     }
 
     }
}</lsl>
+
}</source>
 
|spec=
 
|spec=
 
===Physics===
 
===Physics===
*If the object is not physical or the script is attached to a child prim, then the effect is entirely client side. The rotation experienced by the user '''cannot''' be detected or queried by script.
 
 
*If the object is physical and the script is attached to the root prim, then the physical representation is updated regularly. The rotation experienced by the user '''can''' be detected or queried by script.
 
*If the object is physical and the script is attached to the root prim, then the physical representation is updated regularly. The rotation experienced by the user '''can''' be detected or queried by script.
 +
*If the object is physical and the script attached to the root prim, the axis of rotation is given by the parameter axis and contains the center of mass [[llGetCenterOfMass]]. The axis parameter gives the direction of the axis of rotation. If the center of the object is not the center of mass, the center of the object "orbits" around the center of mass.
 +
*If the object is physical and the script attached to a child prim: the same, but it s the center of mass of the child prim who is used.
 +
 +
*If the object is not physical or the script is attached to a child prim, then the effect is entirely client side. Only a script within the object itself can  detect this by reading the [[PRIM_OMEGA]] parameters.
 +
*If the object is not physical and  the script is attached to a root prim, the axis of rotation is given by the parameter axis and contains the center of the  object (center of root prim).
 +
*If the object is not physical and  the script is attached to a child prim: the same, but it s the center of the prim who is used
 
===Link Sets===
 
===Link Sets===
*If the script is attached to the root prim, the entire object rotates around the [[Viewer coordinate frames#Region|region]] '''axis'''.
+
*If the script is attached to the root prim, the entire object rotates around the [[Viewer coordinate frames#Region|region]] {{LSLP|axis}}.
**If the object is attached then it rotates around the attachment '''axis'''
+
**If the object is attached then it rotates around the attachment {{LSLP|axis}}.
*If the script is attached to a child prim, the prim rotates around the [[Viewer coordinate frames#Local|local]] '''axis'''.
+
*If the script is attached to a child prim, the prim rotates around the [[Viewer coordinate frames#Local|local]] {{LSLP|axis}}.
**A child prim can rotate around its own '''axis''' while the entire object rotates around another '''axis'''.
+
**A child prim can rotate around its own {{LSLP|axis}} while the entire object rotates around another {{LSLP|axis}}.
 
|caveats=*If the object is not physical then the rotation is only a client side effect and it will collide as non-moving geometry.
 
|caveats=*If the object is not physical then the rotation is only a client side effect and it will collide as non-moving geometry.
 
*If the function does not appear to be working, make sure that that Advanced > Network > Velocity Interpolate Objects (viewer 1.x) or Develop > Network > Velocity Interpolate Objects (viewer 2.x) is enabled.
 
*If the function does not appear to be working, make sure that that Advanced > Network > Velocity Interpolate Objects (viewer 1.x) or Develop > Network > Velocity Interpolate Objects (viewer 2.x) is enabled.
Line 57: Line 62:
 
|also_articles
 
|also_articles
 
|also_tests={{LSL DefineRow||[[llTargetOmega test]]|}}
 
|also_tests={{LSL DefineRow||[[llTargetOmega test]]|}}
|notes=* Use [[llVecNorm]] on '''axis''' so that '''spinrate''' actually represents the rate of rotation.
+
|notes=* Use [[llVecNorm]] on {{LSLP|axis}} so that {{LSLP|spinrate}} actually represents the rate of rotation.
 
* Set the gain to zero to disable and remove the rotation behavior, eg <code>llTargetOmega([[ZERO_VECTOR]], 0, 0)</code>;
 
* Set the gain to zero to disable and remove the rotation behavior, eg <code>llTargetOmega([[ZERO_VECTOR]], 0, 0)</code>;
 
** A spinrate of 0 with a nonzero gain causes the object to try to stop all spin, rather than simply clearing a previous llTargetOmega() call.   
 
** A spinrate of 0 with a nonzero gain causes the object to try to stop all spin, rather than simply clearing a previous llTargetOmega() call.   
Line 70: Line 75:
 
|cat7
 
|cat7
 
|cat8
 
|cat8
 +
|history={{LSL Added|0.2.0|remote=http://secondlife.wikia.com/wiki/Version_0.2.0}}
 +
|haiku={{Haiku|Life's a carousel:|Whirling colors, spinning fate.|A grand illusion.}}
 
}}
 
}}

Latest revision as of 11:30, 22 January 2015

Summary

Function: llTargetOmega( vector axis, float spinrate, float gain );

Rotates the object/prim around axis at a rate of spinrate * llVecMag(axis) in radians per second with strength gain.

• vector axis arbitrary axis to rotate the object around
• float spinrate rate of rotation in radians per second
• float gain also modulates the final spinrate and disables the rotation behavior if zero

Specification

Physics

  • If the object is physical and the script is attached to the root prim, then the physical representation is updated regularly. The rotation experienced by the user can be detected or queried by script.
  • If the object is physical and the script attached to the root prim, the axis of rotation is given by the parameter axis and contains the center of mass llGetCenterOfMass. The axis parameter gives the direction of the axis of rotation. If the center of the object is not the center of mass, the center of the object "orbits" around the center of mass.
  • If the object is physical and the script attached to a child prim: the same, but it s the center of mass of the child prim who is used.
  • If the object is not physical or the script is attached to a child prim, then the effect is entirely client side. Only a script within the object itself can detect this by reading the PRIM_OMEGA parameters.
  • If the object is not physical and the script is attached to a root prim, the axis of rotation is given by the parameter axis and contains the center of the object (center of root prim).
  • If the object is not physical and the script is attached to a child prim: the same, but it s the center of the prim who is used

Link Sets

  • If the script is attached to the root prim, the entire object rotates around the region axis.
    • If the object is attached then it rotates around the attachment axis.
  • If the script is attached to a child prim, the prim rotates around the local axis.
    • A child prim can rotate around its own axis while the entire object rotates around another axis.

Caveats

  • If the object is not physical then the rotation is only a client side effect and it will collide as non-moving geometry.
  • If the function does not appear to be working, make sure that that Advanced > Network > Velocity Interpolate Objects (viewer 1.x) or Develop > Network > Velocity Interpolate Objects (viewer 2.x) is enabled.
All Issues ~ Search JIRA for related Bugs

Examples

//rotates the x axis once per second,
//  rotates the y axis 3 times per second, 
//  rotates the z axis once every two seconds.
//  combined the rate is about 3.20156 revolutions per second
 
llTargetOmega(<1.0,3.0,0.5>,TWO_PI,1.0);
 //Rotates very slowly around a sphere's local X axis .... Good for making a globe that rotates around a tilted axis
 
default
{
    state_entry()
    {
       llTargetOmega(<1.0,0.0,0.0>*llGetRot(),0.1,0.01);
    }
}
 //Rotates very slowly around a cylinder's local or global Z axis
 // .... Good for making a propeller that rotates regardless of initial orientation.
 
default
{
    state_entry()
    {
       llTargetOmega(llRot2Up(llGetLocalRot()), PI, 1.0);
    }
}

Notes

  • Use llVecNorm on axis so that spinrate actually represents the rate of rotation.
  • Set the gain to zero to disable and remove the rotation behavior, eg llTargetOmega(ZERO_VECTOR, 0, 0);
    • A spinrate of 0 with a nonzero gain causes the object to try to stop all spin, rather than simply clearing a previous llTargetOmega() call.
  • If there are other forces applied to a prim together with llTargetOmega(), (like using llSetForce to make the object float), use llTargetOmega(-llGetOmega(), 0., 1.) to cancel spin. Note that the gain must be non-zero, but not necessarily 1.

See Also

Functions

•  llRot2Fwd Gets the orientation of the local x-axis relative to the earth
•  llRot2Left Gets the orientation of the local y-axis relative to the earth
•  llRot2Up Gets the orientation of the local z-axis relative to the earth

Deep Notes

History

All Issues

~ Search JIRA for related Issues
   llSetSyncTime() - a function for synchronising client side effects

Tests

•  llTargetOmega test

Footnotes

  1. ^ Early release notes were not very accurate or thorough, they sometimes included information about features added in previous releases or failed to include information about features added in that release.

Signature

function void llTargetOmega( vector axis, float spinrate, float gain );

Haiku

Life's a carousel:
Whirling colors, spinning fate.
A grand illusion.