Difference between revisions of "PRIM TEXTURE"

From Second Life Wiki
Jump to navigation Jump to search
m (<lsl> tag to <source>)
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<onlyinclude>{{#if:
<onlyinclude>{{#if:


{{#vardefine:return|[&nbsp;{{HoverText|""|string texture}}, {{HoverLink|ZERO_VECTOR|{{LSL VR|0.0|0.0|0.0}} vector repeats}}, {{HoverLink|ZERO_VECTOR|{{LSL VR|0.0|0.0|0.0}} vector offsets}}, {{HoverText|0.0|float rotation_in_radians}}&nbsp;]}}
{{#vardefine:texture_return|an empty list.}}


{{#vardefine:texture_const|{{LSL Const|PRIM_TEXTURE|integer|17|c=Used to {{GetSet|{{{1|}}}|get|set|/}} the texture settings of a prim's face}}}}
{{#vardefine:texture_const|{{LSL Const|PRIM_TEXTURE|integer|17|c=Used to {{GetSet|{{{1|}}}|get|set|/}} the texture settings of a prim's face}}}}
Line 10: Line 10:
{{#vardefine:p_offsets_desc|x and y range from -1 to 1 (z is ignored)}}
{{#vardefine:p_offsets_desc|x and y range from -1 to 1 (z is ignored)}}


{{LSL_Function/inventory|texture|uuid=true|type=texture|no_caveat={{#ifeq:{{{1|}}}|get|true}}|full={{{remote|}}}}}
{{LSL_Function/inventory|texture|uuid=true|type=texture|no_caveat={{#ifeq:{{{1|}}}|get|true|<noinclude>*</noinclude>}}|full={{{remote|}}}|remote={{#ifeq:{{{1|set}}}|get|*}}|target=PRIM_TEXTURE#Target}}
 
{{#ifeq:{{{1|}}}|none||


{{#vardefine:facetable|{{#var:facetable}}
{{#vardefine:facetable|{{#var:facetable}}
{{!}}-
{{!}}-
{{!}} [ {{#var:texture_const}} ]
{{!}} [ {{#var:texture_const}} ]
{{!}} {{#var:return}} }}
{{!}} {{#var:texture_return}} }}
 
{{#vardefine:caveats_get|
* {{LSLP|repeats}} is not only used to get the number of repeats but the sign of the individual components indicate if "Flip" is set.
* With {{LSLP|texture}} as with [[llGetTexture]], {{LSL Constant/NULL KEY}} is returned when the {{LSLGC|Owner|owner}} does not have {{LSLGC|Permissions/Asset|full permissions}} to the object and the [[PRIM_TEXTURE|texture]] is not in the prim's inventory.}}
 
{{#vardefine:caveats_set|
* {{LSLP|repeats}} is not only used to set the number of repeats but the sign of the individual components is also used to set the "Flip" attribute.}}


{{#ifeq:{{{1|}}}|get|
{{#ifeq:{{{1|}}}|get|


{{#vardefine:caveats|{{#var:caveats}}
{{#vardefine:caveats|{{#var:caveats}}
* {{LSLP|repeats}} is not only used to get the number of repeats but the sign of the individual components indicate if "Flip" is set.}}
{{#var:caveats_get}}
}}


|
|
Line 26: Line 36:
{{Issues/SVC-914}}
{{Issues/SVC-914}}
{{#vardefine:caveats|{{#var:caveats}}
{{#vardefine:caveats|{{#var:caveats}}
* {{LSLP|repeats}} is not only used to set the number of repeats but the sign of the individual components is also used to set the "Flip" attribute.}}
{{#var:caveats_set}}
}}
 
}}
 
<noinclude>
{{:PRIM TEXGEN|{{{1|}}}}}
</noinclude>


}}
}}


{{#vardefine:shared_caveat|* In the [[PRIM_TEXGEN_DEFAULT|default]] [[PRIM_TEXGEN|texture mapping]] {{LSLP|tg_type|mode}} the [[PRIM_TEXTURE|texture]] {{LSLP|repeats}} units are in texture repeats per face. In the [[PRIM_TEXGEN_PLANAR|planar]] texture mapping mode the texture {{LSLP|repeats}} units are in texture repeats per half meter. This is in contrast to the in-world editing tool, in which the planar texture scaling units are repeats per meter.}}
{{#vardefine:caveats|{{#var:caveats}}
{{#var:shared_caveat}}}}


}}</onlyinclude>{{#if:
}}</onlyinclude>{{#if:
Line 36: Line 57:
{{#vardefine:issues_set|{{#var:issues}}{{#vardefine:issues|}}}}
{{#vardefine:issues_set|{{#var:issues}}{{#vardefine:issues|}}}}


{{LSL_Function/face|face|{{#var:texture_const}}|!footer=*|return={{#var:return}}}}
{{LSL_Function/face|face|{{#var:texture_const}}|!footer=*|return={{#var:texture_return}}}}


{{#vardefine:caveats_get|{{#var:caveats}}{{#vardefine:caveats|}}
{{#vardefine:caveats_get|{{#var:caveats}}{{#vardefine:caveats|}}
* {{LSLP|repeats}} is not only used to get the number of repeats but the sign of the individual components is also used to get it's associated "Flip" attribute.
{{#var:caveats_get}}
* In the default texture mapping mode the {{LSLP|repeats}} units are in texture repeats per face. In the planar texture mapping mode the {{LSLP|repeats}} units are in texture repeats per half meter. This is in contrast to the in-world editing tool, in which the planar texture scaling units are repeats per meter.}}
{{#var:shared_caveat}}}}
{{#vardefine:issues_get|{{#var:issues}}{{#vardefine:issues|}}}}
{{#vardefine:issues_get|{{#var:issues}}{{#vardefine:issues|}}}}


Line 51: Line 72:
|examples=
|examples=
|pa={{LSL Constant/List|i_front=[&#32;{{#var:texture_const}},&#32;|i_end=&nbsp;]|
|pa={{LSL Constant/List|i_front=[&#32;{{#var:texture_const}},&#32;|i_end=&nbsp;]|
|inject-1={{#vardefine:p_texture_desc|}}
{{#vardefine:p_texture_hover|}}
{{#vardefine:direction|_set}}
{{LSL_Function/inventory|texture|uuid=true|type=texture}}
|text=Used with [[llSetPrimitiveParams]] & [[llSetLinkPrimitiveParams]].
|text=Used with [[llSetPrimitiveParams]] & [[llSetLinkPrimitiveParams]].


{{LSL Generic/Caveats|caveats={{#var:caveats_set}}{{#vardefine:caveats_set}}|issues={{#var:issues_set}}|title=*|h=4}}
{{LSL Generic/Caveats|issues={{#var:issues_set}}|title=*|h=4}}


====<tt>texture</tt> Constants====
====<tt>texture</tt> Constants====
Line 60: Line 85:


====Examples====
====Examples====
<lsl>llSetPrimitiveParams([ PRIM_TEXTURE, ALL_SIDES, "5748decc-f629-461c-9a36-a35a221fe21f", <1.0, 1.0, 0.0>, <0.0, 0.0, 0.0>, 0.0 ]);
<source lang="lsl2">llSetPrimitiveParams([ PRIM_TEXTURE, ALL_SIDES, "5748decc-f629-461c-9a36-a35a221fe21f", <1.0, 1.0, 0.0>, <0.0, 0.0, 0.0>, 0.0 ]);
llSetPrimitiveParams([ PRIM_TEXTURE, ALL_SIDES, llGetInventoryName(INVENTORY_TEXTURE, 0), <1.0, 1.0, 0.0>, <0.0, 0.0, 0.0>, 0.0 ]);
llSetPrimitiveParams([ PRIM_TEXTURE, ALL_SIDES, llGetInventoryName(INVENTORY_TEXTURE, 0), <1.0, 1.0, 0.0>, <0.0, 0.0, 0.0>, 0.0 ]);
llSetPrimitiveParams([ PRIM_TEXTURE, 0, TEXTURE_PLYWOOD, <2.0, 5.0, 0.0>, <0.1, 0.2, 0.0>, 1.0 ]);</lsl>
llSetPrimitiveParams([ PRIM_TEXTURE, 0, TEXTURE_PLYWOOD, <2.0, 5.0, 0.0>, <0.1, 0.2, 0.0>, 1.0 ]);</source>


|toc=llSetPrimitiveParams
|toc=llSetPrimitiveParams
Line 72: Line 97:
}}
}}
|pb={{LSL Constant/List|i_front=[[llGetPrimitiveParams]]([&nbsp;{{#var:texture_const}},&#32;|i_end=&nbsp;]);|
|pb={{LSL Constant/List|i_front=[[llGetPrimitiveParams]]([&nbsp;{{#var:texture_const}},&#32;|i_end=&nbsp;]);|
|inject-1={{#vardefine:p_texture_desc|}}
{{#vardefine:p_texture_hover|}}
{{#vardefine:direction|_get}}
{{LSL_Function/inventory|texture|uuid=true|type=texture|no_caveat=true|full={{{remote|}}}|remote=*|target=#Target}}
{{LSL Function/link|link|nogroup=*|nocaveats=*}}
|r_front=Returns the list [&nbsp;|r_end=&nbsp;]
|r_front=Returns the list [&nbsp;|r_end=&nbsp;]
|text=
|text=
{{LSL Generic/Caveats|caveats={{#var:caveats_get}}{{#vardefine:caveats_get}}|issues={{#var:issues_get}}|title=*|h=4}}
{{LSL Generic/Caveats|caveats={{#var:caveats_get}}{{#vardefine:caveats_get}}|issues={{#var:issues_get}}|title=*|h=4}}
====Target====
In the case of llGetPrimitiveParams is either the prim the script resides in, or the prim specified by the immediately prior [[PRIM_LINK_TARGET]] call. However in the case of llGetLinkPrimitiveParams, it is either the value of the {{LSLP|link}} parameter, or the prim specified by the immediately prior [[PRIM_LINK_TARGET]] call.
|toc=llGetPrimitiveParams
|toc=llGetPrimitiveParams
|i1_type=integer|i1_name=face
|i1_type=integer|i1_name=face
Line 102: Line 133:
{{LSL DefineRow||[[changed]]|}}
{{LSL DefineRow||[[changed]]|}}
|location
|location
|cat1
|notes
|cat1=Texture
|cat2
|cat2
|cat3
|cat3
|cat4
|cat4
}}
}}

Revision as of 16:59, 23 January 2015

Description

Constant: integer PRIM_TEXTURE = 17;

The integer constant PRIM_TEXTURE has the value 17

Used to get or set the texture settings of a prim's face.

llSetPrimitiveParams

[ PRIM_TEXTURE, integer face, string texture, vector repeats, vector offsets, float rot ]
• integer face face number or ALL_SIDES
• string texture a texture in the inventory of the prim this script is in or a UUID of a texture
• vector repeats x and y range from 0.0 to 100, or -0.0 to -100 in 0.01 increments. Negative values flip the texture (z is ignored)
• vector offsets x and y range from -1 to 1 (z is ignored)
• float rot angle expressed in radians

Used with llSetPrimitiveParams & llSetLinkPrimitiveParams.

Caveats

  • repeats is not only used to set the number of repeats but the sign of the individual components is also used to set the "Flip" attribute.
  • In the default texture mapping mode the texture repeats units are in texture repeats per face. In the planar texture mapping mode the texture repeats units are in texture repeats per half meter. This is in contrast to the in-world editing tool, in which the planar texture scaling units are repeats per meter.
  • If texture is missing from the prim's inventory and it is not a UUID or it is not a texture then an error is shouted on DEBUG_CHANNEL.
  • If texture is a UUID then there are no new asset permissions consequences for the object.
    • The resulting object develops no new usage restrictions that might have occurred if the asset had been placed in the prims inventory.
All Issues ~ Search JIRA for related Bugs

texture Constants

The following constants can (optionally) be used for the texture value: TEXTURE_BLANK, TEXTURE_DEFAULT, TEXTURE_MEDIA, TEXTURE_PLYWOOD and TEXTURE_TRANSPARENT.

Examples

llSetPrimitiveParams([ PRIM_TEXTURE, ALL_SIDES, "5748decc-f629-461c-9a36-a35a221fe21f", <1.0, 1.0, 0.0>, <0.0, 0.0, 0.0>, 0.0 ]);
llSetPrimitiveParams([ PRIM_TEXTURE, ALL_SIDES, llGetInventoryName(INVENTORY_TEXTURE, 0), <1.0, 1.0, 0.0>, <0.0, 0.0, 0.0>, 0.0 ]);
llSetPrimitiveParams([ PRIM_TEXTURE, 0, TEXTURE_PLYWOOD, <2.0, 5.0, 0.0>, <0.1, 0.2, 0.0>, 1.0 ]);

llGetPrimitiveParams

llGetPrimitiveParams([ PRIM_TEXTURE, integer face ]);

Returns the list [ string texture, vector repeats, vector offsets, float rot ]

• integer face face number or ALL_SIDES

• string texture a texture in the inventory of the target prim or a UUID of a texture
• vector repeats x and y range from 0.0 to 100, or -0.0 to -100 in 0.01 increments. Negative values flip the texture (z is ignored)
• vector offsets x and y range from -1 to 1 (z is ignored)
• float rot angle expressed in radians

Caveats

  • If face is ALL_SIDES then the PRIM_TEXTURE works on all sides.
  • If face indicates a face that does not exist the PRIM_TEXTURE return is an empty list.
  • repeats is not only used to get the number of repeats but the sign of the individual components indicate if "Flip" is set.
  • With texture as with llGetTexture, NULL_KEY is returned when the owner does not have full permissions to the object and the texture is not in the prim's inventory.
  • In the default texture mapping mode the texture repeats units are in texture repeats per face. In the planar texture mapping mode the texture repeats units are in texture repeats per half meter. This is in contrast to the in-world editing tool, in which the planar texture scaling units are repeats per meter.
All Issues ~ Search JIRA for related Bugs

Target

In the case of llGetPrimitiveParams is either the prim the script resides in, or the prim specified by the immediately prior PRIM_LINK_TARGET call. However in the case of llGetLinkPrimitiveParams, it is either the value of the link parameter, or the prim specified by the immediately prior PRIM_LINK_TARGET call.

Related Articles

Constants

•  CHANGED_TEXTURE
•  TEXTURE_BLANK
•  TEXTURE_DEFAULT
•  TEXTURE_PLYWOOD
•  TEXTURE_TRANSPARENT
•  TEXTURE_MEDIA

Functions

•  llSetPrimitiveParams
•  llSetLinkPrimitiveParams
•  llGetPrimitiveParams
•  llSetTexture
•  llSetLinkTexture
•  llScaleTexture
•  llOffsetTexture
•  llRotateTexture
•  llGetLinkNumber Returns the link number of the prim the script is in.

Events

•  changed

Notes

Link Numbers

Each prim that makes up an object has an address, a link number. To access a specific prim in the object, the prim's link number must be known. In addition to prims having link numbers, avatars seated upon the object do as well.

  • If an object consists of only one prim, and there are no avatars seated upon it, the (root) prim's link number is zero.
  • However, if the object is made up of multiple prims or there is an avatar seated upon the object, the root prim's link number is one.

When an avatar sits on an object, it is added to the end of the link set and will have the largest link number. In addition to this, while an avatar is seated upon an object, the object is unable to link or unlink prims without unseating all avatars first.

Counting Prims & Avatars

There are two functions of interest when trying to find the number of prims and avatars on an object.

integer GetPrimCount() { //always returns only the number of prims
    if(llGetAttached())//Is it attached?
        return llGetNumberOfPrims();//returns avatars and prims but attachments can't be sat on.
    return llGetObjectPrimCount(llGetKey());//returns only prims but won't work on attachments.
}
See llGetNumberOfPrims for more about counting prims and avatars.

Errata

If a script located in a child prim erroneously attempts to access link 0, it will get or set the property of the linkset's root prim. This bug (BUG-5049) is preserved for broken legacy scripts.

Deep Notes

Search JIRA for related Issues

Footnotes

  1. ^ LINK_ROOT does not work on single prim objects. Unless there is an avatar sitting on the object.

Signature

integer PRIM_TEXTURE = 17;