Difference between revisions of "LlDetectedTouchST"

From Second Life Wiki
Jump to navigation Jump to search
m (changed texture uuid in example script and comments)
m (Whoops — missed a replacement of <source> with <syntaxhighlight>...)
 
(12 intermediate revisions by 7 users not shown)
Line 3: Line 3:
|func_id=342|func_sleep=0.0|func_energy=10.0
|func_id=342|func_sleep=0.0|func_energy=10.0
|func=llDetectedTouchST
|func=llDetectedTouchST
|return_type=vector|return_text=that is the surface coordinates for where the prim was touched. The {{LSLP|x}} & {{LSLP|y}} vector positions contain the horizontal ({{LSLP|s}}) & vertical ({{LSLP|t}}) face coordinates respectively (<code>{{NoWrap|{{LSL_VR|{{LSLPT|s}}|{{LSLPT|t}}|0.0}}}}</code>). Each component is in the interval {{Interval|gte=0.0|center=component|lte=1.0}} with the origin in the bottom left corner.{{Interval/Footnote}}
|return_type=vector|return_text=that is the surface coordinates for where the prim was touched. The {{LSLP|x}} & {{LSLP|y}} vector positions contain the horizontal ({{LSLP|s}}) & vertical ({{LSLP|t}}) face coordinates respectively (<code>{{NoWrap|{{LSL_VR|{{LSLPT|s}}|{{LSLPT|t}}|0.0}}}}</code>). Each component is usually in the interval {{Interval|gte=0.0|center=component|lte=1.0}} with the origin in the bottom left corner.{{Interval/Footnote}} With some mesh objects, values of less than 0.0 and higher than 1.0 have been observed.


{{LSL Const|TOUCH_INVALID_TEXCOORD|vector|{{LSL_VR|-1.0|-1.0|0.0}}}} is returned when the surface coordinates cannot be determined. See [[#Caveats|Caveats]] for further details.
{{LSL Const|TOUCH_INVALID_TEXCOORD|vector|{{LSL_VR|-1.0|-1.0|0.0}}}} is returned when the surface coordinates cannot be determined. See [[#Caveats|Caveats]] for further details.
|p1_type=integer|p1_name=index
|p1_type=integer|p1_name=index
|func_footnote=For the {{LSLGC|Touch|touch}} category of events only. The prim that was touched may not be the prim receiving the event, use [[llDetectedLinkNumber]] to check for this; likewise you can use [[llDetectedTouchFace]] to determine which face was touched.
|func_footnote=For the {{LSLGC|Touch|touch}} category of events only. The prim that was touched may not be the prim receiving the event, use [[llDetectedLinkNumber]] to check for this; likewise, you can use [[llDetectedTouchFace]] to determine which face was touched.
|func_desc
|func_desc
|spec
|spec
Line 18: Line 18:
** The event triggered is not a {{LSLGC|Touch|touch}} event.
** The event triggered is not a {{LSLGC|Touch|touch}} event.
|examples=
|examples=
<lsl>
<syntaxhighlight lang="lsl2">
//  whisper touched location upon face
 
default
default
{
{
     touch_start(integer num_detected)
     touch_start(integer total_number)
     {
     {
         integer detectedFace = llDetectedTouchFace(0);
         integer touchFace = llDetectedTouchFace(0);
         vector detectedTouchST = llDetectedTouchST(0);
         vector touchST  = llDetectedTouchST(0);
 
//      ZERO_VECTOR (<0.0, 0.0, 0.0> ... the origin) is in the bottom left corner of the face
//      touchST.x goes across the face from the left to the right
//      touchST.y goes up the face from the bottom to the top


         if (detectedFace == -1)
         if (touchFace == -1)
//      {
//          PUBLIC_CHANNEL has the integer value 0
             llWhisper(PUBLIC_CHANNEL, "Sorry, your viewer doesn't support touched faces.");
             llWhisper(PUBLIC_CHANNEL, "Sorry, your viewer doesn't support touched faces.");
//      }
         else if (touchST == TOUCH_INVALID_TEXCOORD)
//      TOUCH_INVALID_TEXCOORD has the vector value <-1.0, -1.0, 0.0>
             llWhisper(PUBLIC_CHANNEL, "Sorry, the touch position upon the face could not be determined.");
         else if (detectedTouchST == TOUCH_INVALID_TEXCOORD)
//      {
             llWhisper(PUBLIC_CHANNEL, "Sorry, the surface touch position could not be determined.");
//      }
         else
         else
//      {
             llSay(PUBLIC_CHANNEL, "llDetectedTouchST(0) = " + (string)touchST
             llWhisper(PUBLIC_CHANNEL, (string)detectedTouchST);
                    + "\ntouchST.x = " + (string)touchST.x
//      }
                    + "\ntouchST.y = " + (string)touchST.y);
     }
     }
}
}
</lsl>
</syntaxhighlight>
<lsl>
 
The following script will assume an (imaginary) 12x12 grid over the face, and identify which square was touched by the user.
<syntaxhighlight lang="lsl2">
integer numberOfRows    = 12;
integer numberOfColumns = 12;
 
default
{
    touch_start(integer total_number)
    {
        vector  touchST    = llDetectedTouchST(0);
 
//      ZERO_VECTOR (<0.0, 0.0, 0.0> ... the origin) is in the bottom left corner of the face
//      touchST.x goes across the face from the left to the right
//      touchST.y goes up the face from the bottom to the top
 
        integer columnIndex = (integer) (touchST.x * numberOfColumns);
        integer rowIndex    = (integer) (touchST.y * numberOfRows);
        integer cellIndex  = (rowIndex * numberOfColumns) + columnIndex;
 
        llSay(PUBLIC_CHANNEL, "ST grid (" + (string)columnIndex + ", " + (string)rowIndex
                            + ") --> cell " + (string)cellIndex);
    }
}
</syntaxhighlight>
<syntaxhighlight lang="lsl2">
//  with friendly permission of Supremius Maximus
//  with friendly permission of Supremius Maximus
//  who made the texture used in this script
//  who made the texture used in this script
//
//
//  click&hold the mouse while dragging across
//  click & hold the mouse while dragging across
//  the face of the prim
//  the face of the prim


Line 56: Line 77:
     touch(integer num_detected)
     touch(integer num_detected)
     {
     {
         integer face = llDetectedTouchFace(0);
        integer link    = llDetectedLinkNumber(0);
         vector touchST = llDetectedTouchST(0);
         integer face   = llDetectedTouchFace(0);
         vector touchST = llDetectedTouchST(0);
 
//      ZERO_VECTOR (<0.0, 0.0, 0.0> ... the origin) is in the bottom left corner of the face
//      touchST.x goes across the face from the left to the right
//      touchST.y goes across the face from the bottom to the top


         string uuid = "23badbe7-6d8c-639b-0131-bb321f8e9db5";
         string uuid = "23badbe7-6d8c-639b-0131-bb321f8e9db5";


         llSetLinkPrimitiveParamsFast(LINK_THIS, [
         llSetLinkPrimitiveParamsFast(link, [
             PRIM_TEXTURE, face, uuid, <1.0, 1.0, 0.0>, touchST, (float)FALSE,
             PRIM_TEXTURE, face, uuid, <1.0, 1.0, 0.0>, touchST, 0,
             PRIM_FULLBRIGHT, ALL_SIDES, TRUE]);
             PRIM_FULLBRIGHT, ALL_SIDES, TRUE]);
     }
     }
}
}
</lsl>
</syntaxhighlight>
<lsl>
//  touchST.x goes across from the left to the right
//  touchST.y goes up from the bottom to the top
//  <0.0, 0.0, 0.0> is in the bottom left corner
 
integer numberOfRows = 12;
integer numberOfColumns = 12;
 
default
{
    touch_start(integer total_number)
    {
        vector touchST = llDetectedTouchST(0);
        integer columnIndex = llFloor(touchST.x * numberOfColumns);
        integer rowIndex = llFloor(touchST.y * numberOfRows);
        integer cellIndex = (rowIndex * numberOfColums) + columnIndex;
 
        llSay(PUBLIC_CHANNEL, "(" + (string)columnIndex + ", " + (string)rowIndex + ") --> " + (string)cellIndex);
    }
}
</lsl>
 
|helpers
|helpers
|related
|related
Line 104: Line 108:
|also_articles
|also_articles
|notes
|notes
|history=Introduced in Viewer {{SVN|870|rev=92872|branch=Release|anchor=file14|date=Wednesday, 23 July 2008}}, Supported by Beta Server 1.24.0.93754 (Wenesday 6th August 2008), and viewer binary 1.20.15 (93532).
|history=*Introduced in Viewer {{SVN|870|rev=92872|branch=Release|anchor=file14|date=Wednesday, 23 July 2008}}, Supported by Beta Server 1.24.0.93754 (Wenesday 6th August 2008), and viewer binary 1.20.15 (93532).
*Date of Release Server [[ Release_Notes/Second_Life_Beta_Server/1.24#Release_Notes_for_Second_Life_Beta_Server_1.24.3_.28August_29th.2C_2008.29 | 29-08-2008 ]]
*Date of Release Client  [[ Release_Notes/Second_Life_Release/1.21 | 16-10-2008 ]]
|cat1=Touch
|cat1=Touch
|cat2
|cat2
|cat3
|cat3
|cat4
|cat4
|haiku={{Haiku|Gently touching face,|Odd emotion arises.|Laughter fills the space.}}
}}
}}

Latest revision as of 10:48, 10 June 2023

Summary

Function: vector llDetectedTouchST( integer index );
0.0 Forced Delay
10.0 Energy

Returns a vector that is the surface coordinates for where the prim was touched. The x & y vector positions contain the horizontal (s) & vertical (t) face coordinates respectively (<s, t, 0.0>). Each component is usually in the interval [0.0, 1.0] with the origin in the bottom left corner.[1] With some mesh objects, values of less than 0.0 and higher than 1.0 have been observed.

TOUCH_INVALID_TEXCOORD is returned when the surface coordinates cannot be determined. See Caveats for further details.

• integer index Index of detection information

index does not support negative indexes. For the touch category of events only. The prim that was touched may not be the prim receiving the event, use llDetectedLinkNumber to check for this; likewise, you can use llDetectedTouchFace to determine which face was touched.

Caveats

  • If index is out of bounds the script continues to execute without an error message.
  • TOUCH_INVALID_TEXCOORD is returned when...
    • The avatar's viewer does not support face touch detection.
    • The touch has moved off the surface of the prim.
    • The touch happened too close to the edge of the face to determine a location.
    • The event triggered is not a touch event.

Examples

default
{
    touch_start(integer total_number)
    {
        integer touchFace = llDetectedTouchFace(0);
        vector  touchST   = llDetectedTouchST(0);

//      ZERO_VECTOR (<0.0, 0.0, 0.0> ... the origin) is in the bottom left corner of the face
//      touchST.x goes across the face from the left to the right
//      touchST.y goes up the face from the bottom to the top

        if (touchFace == -1)
            llWhisper(PUBLIC_CHANNEL, "Sorry, your viewer doesn't support touched faces.");
        else if (touchST == TOUCH_INVALID_TEXCOORD)
            llWhisper(PUBLIC_CHANNEL, "Sorry, the touch position upon the face could not be determined.");
        else
            llSay(PUBLIC_CHANNEL, "llDetectedTouchST(0) = " + (string)touchST
                    + "\ntouchST.x = " + (string)touchST.x
                    + "\ntouchST.y = " + (string)touchST.y);
    }
}

The following script will assume an (imaginary) 12x12 grid over the face, and identify which square was touched by the user.

integer numberOfRows    = 12;
integer numberOfColumns = 12;

default
{
    touch_start(integer total_number)
    {
        vector  touchST     = llDetectedTouchST(0);

//      ZERO_VECTOR (<0.0, 0.0, 0.0> ... the origin) is in the bottom left corner of the face
//      touchST.x goes across the face from the left to the right
//      touchST.y goes up the face from the bottom to the top

        integer columnIndex = (integer) (touchST.x * numberOfColumns);
        integer rowIndex    = (integer) (touchST.y * numberOfRows);
        integer cellIndex   = (rowIndex * numberOfColumns) + columnIndex;

        llSay(PUBLIC_CHANNEL, "ST grid (" + (string)columnIndex + ", " + (string)rowIndex
                            + ") --> cell " + (string)cellIndex);
    }
}
//  with friendly permission of Supremius Maximus
//  who made the texture used in this script
//
//  click & hold the mouse while dragging across
//  the face of the prim

default
{
    touch(integer num_detected)
    {
        integer link    = llDetectedLinkNumber(0);
        integer face    = llDetectedTouchFace(0);
        vector  touchST = llDetectedTouchST(0);

//      ZERO_VECTOR (<0.0, 0.0, 0.0> ... the origin) is in the bottom left corner of the face
//      touchST.x goes across the face from the left to the right
//      touchST.y goes across the face from the bottom to the top

        string uuid = "23badbe7-6d8c-639b-0131-bb321f8e9db5";

        llSetLinkPrimitiveParamsFast(link, [
            PRIM_TEXTURE, face, uuid, <1.0, 1.0, 0.0>, touchST, 0,
            PRIM_FULLBRIGHT, ALL_SIDES, TRUE]);
    }
}

See Also

Deep Notes

History

Footnotes

  1. ^ The ranges in this article are written in Interval Notation.

Signature

function vector llDetectedTouchST( integer index );

Haiku

Gently touching face,
Odd emotion arises.
Laughter fills the space.