TextureAtlas Sparrow XML Format

Starling Forum » Starling Framework » General Discussion

TextureAtlas Sparrow XML Format

(13 posts) (4 voices)

Started 1 year ago by neokeats
Latest reply from Daniel

Tags:

neokeats

Competent Bird
Joined: Feb '12
Posts: 21

hi,

http://doc.starling-framework.org/core/starling/textures/TextureAtlas.html
the documentation says :

If your images have transparent areas at their edges, you can make use of the frame property of the Texture class. Trim the texture by removing the transparent edges and specify the original texture size like this:

<SubTexture name='trimmed' x='0' y='0' height='10' width='10'
frameX='-10' frameY='-10' frameWidth='30' frameHeight='30'/>

but it's not clear enought, what are frameX, frameY, frameWidth, frameHeight ?
the frameX and frameY are added ?

Posted 1 year ago #
neokeats

Competent Bird
Joined: Feb '12
Posts: 21

nevermind it's explained in
http://doc.starling-framework.org/core/starling/textures/Texture.html

Posted 1 year ago #
sHTiF

Moderating Owl
Joined: Oct '11
Posts: 828

Interesting, what do you need the original framesize for? It will internally create texture with zero alpha pixels? What for?

Posted 1 year ago #

neokeats

Competent Bird
Joined: Feb '12
Posts: 21

i'm making an extension for spriteloq ( http://www.loqheart.com/spriteloq/ ) so i needed to understand what was needed tio make a valid sparrow xml since

<code>target Sparrow</code>
<code>extension xml</code>
<?xml version="1.0" encoding="UTF-8"?>
 
<TextureAtlas imagePath="<code>exportName</code>.png">
	<code>assets</code>
	<code>assetFrames</code>
         <SubTexture name="<code>assetName</code>_<code>frameIndex</code>"
                 x="<code>frameTextureRectX</code>"
                 y="<code>frameTextureRectY</code>"
                 width="<code>frameTextureRectWidth</code>"
                 height="<code>frameTextureRectHeight</code>"
	<code>endAssets</code>
</TextureAtlas>

works but doesn't handle the cropping parts, i need to add frameX frameY frameWidth frameHeight to handle thoses cases too...

Posted 1 year ago #

sHTiF

Moderating Owl
Joined: Oct '11
Posts: 828

That was probably a question for daniel since I am interested why would anyone need the framesizes. I mean why create a texture with empty alpha bounds?

Posted 1 year ago #
Josh Tynjala

Feathers Guru
Joined: Feb '12
Posts: 2,480

@sHTiF Increase the hit area for touches? You could do that manually in your code, of course, but it is convenient to export an image with some empty alpha regions and have it all done automatically for you.

Posted 1 year ago #
sHTiF

Moderating Owl
Joined: Oct '11
Posts: 828

Josh the question is if it actually creates a texture with zero alpha bounds or only assumes for collision detection that they are there. I mean empty alpha regions just for touches is not a smart thign to do, they have to be rendered and therefore have impact on performance.

Posted 1 year ago #
Josh Tynjala

Feathers Guru
Joined: Feb '12
Posts: 2,480

Oh, I see. You want to know if Starling adds the alpha back or not.

Posted 1 year ago #
Daniel

Primary Feather
Joined: Jan '10
Posts: 2,448

sHTiF, this is useful to save texture memory. Tools like TexturePacker can trim the transparent regions from textures and tell Starling the original bounds of the texture via the frame property.

On rendering, Starling of course does NOT just re-add the transparent pixels. Instead, it moves the complete quad (image) to where it would be, hadn't it been trimmed. This happens transparently to the user.

That's especially useful in MovieClips: in Starling, a MovieClip is just an image that changes its texture over time; thus, all frames should have textures with the same size. You can do just that now, without taking care about the transparent edges, because they will be trimmed away by TexturePacker.

Posted 1 year ago #

neokeats

Competent Bird
Joined: Feb '12
Posts: 21

if anyone is interested, to be able to export xml sparrow-compatible with spriteloq

create an export template in C:\Program Files (x86)\Spriteloq\enabled_export_templates
named for example : sparrow.meta
and put this contain :

<code>target Sparrow</code>
<code>extension xml</code>
<?xml version="1.0" encoding="UTF-8"?>
<TextureAtlas imagePath="<code>exportName</code>.png">
	<code>assets</code>
		<code>assetFrames</code><SubTexture name="<code>assetName</code>_<code>frameIndex</code>" x="<code>frameTextureRectX</code>" y="<code>frameTextureRectY</code>" width="<code>frameTextureRectWidth</code>" height="<code>frameTextureRectHeight</code>" frameX="-<code>frameSpriteColorRectX</code>" frameY="-<code>frameSpriteColorRectY</code>" frameWidth="<code>assetBoundsWidth</code>" frameHeight="<code>assetBoundsHeight</code>" /><code>endAssetFrames</code>
	<code>endAssets</code>
</TextureAtlas>

and that's it

if you want the support of modifications on reference point

<code>target Sparrow</code>
<code>extension xml</code>
<?xml version="1.0" encoding="UTF-8"?>
<TextureAtlas imagePath="<code>exportName</code>.png">
	<code>assets</code>
		<code>assetFrames</code><SubTexture name="<code>assetName</code>_<code>frameIndex</code>" x="<code>frameTextureRectX</code>" y="<code>frameTextureRectY</code>" width="<code>frameTextureRectWidth</code>" height="<code>frameTextureRectHeight</code>" frameX="<code>assetReferenceX</code> - (<code>assetBoundsWidth</code>/2.0 + <code>assetBoundsX</code>)-<code>frameSpriteColorRectX</code>" frameY="<code>assetReferenceY</code> - (<code>assetBoundsHeight</code>/2.0 + <code>assetBoundsY</code>)-<code>frameSpriteColorRectY</code>" frameWidth="<code>assetBoundsWidth</code>" frameHeight="<code>assetBoundsHeight</code>" /><code>endAssetFrames</code>
	<code>endAssets</code>
</TextureAtlas>

but since TextureAtlas don't "eval" coordinates you have to create an onther or modify the starling one :

import r1.deval.D;
 
...
private function parseAtlasXml(atlasXml:XML):void
        {
            var scale:Number = mAtlasTexture.scale;
 
            for each (var subTexture:XML in atlasXml.SubTexture)
            {
                var val:*;
				var name:String        = subTexture.attribute("name");
                var x:Number           = parseFloat(subTexture.attribute("x")) / scale;
                var y:Number           = parseFloat(subTexture.attribute("y")) / scale;
                var width:Number       = parseFloat(subTexture.attribute("width")) / scale;
                var height:Number      = parseFloat(subTexture.attribute("height")) / scale;
				val = subTexture.attribute("frameX").toString();
				val = D.eval(val);
                var frameX:Number      = parseFloat(val) / scale;
				val = subTexture.attribute("frameY").toString();
				val = D.eval(val);
                var frameY:Number      = parseFloat(val) / scale;
				val = subTexture.attribute("frameWidth").toString();
				val = D.eval(val);
                var frameWidth:Number  = parseFloat(val) / scale;
				val = subTexture.attribute("frameHeight").toString();
				val = D.eval(val);
                var frameHeight:Number = parseFloat(val) / scale;
 
                var region:Rectangle = new Rectangle(x, y, width, height);
                var frame:Rectangle  = frameWidth > 0 && frameHeight > 0 ?
                        new Rectangle(frameX, frameY, frameWidth, frameHeight) : null;
 
                addRegion(name, region, frame);
            }
        }

Posted 1 year ago #

sHTiF

Moderating Owl
Joined: Oct '11
Posts: 828

Daniel oh I get it, so it is just for mouse collision after all. The moving you mentioned is not something original framesize covers anyway, I mean if I have 20x20px and original is 40x40x it doesn't say anything about where it was. Its something the pivot handles the original size isn't really needed here as far as I see it.

Posted 1 year ago #
Daniel

Primary Feather
Joined: Jan '10
Posts: 2,448

Well, yes, it's for hit tests and so that "texture.width/height" and "image.width/height" return the original sizes. Behind the scenes, this will lead to the quad being at a different position than where it would have been if the texture hadn't been trimmed -- that's what I meant with "moved".

Posted 1 year ago #
Daniel

Primary Feather
Joined: Jan '10
Posts: 2,448

Neokeats, thanks for posting the code for Spriteloq! I'm sure that's interesting for a lot of users! =)

Posted 1 year ago #

RSS feed for this topic

Reply

You must log in to post.