The CircleImage provides a circular shaped display for a texture.
| CircleImage | The CircleImage provides a circular shaped display for a texture. |
| XML Definition | This is the CircleImage xml definition. |
| XML Tag | |
| Optional Attributes | These are optional. |
| texture | Name of the Ui Texture to display. |
| slice | Name of the <Slice> in the Ui Texture to display. |
| numsegments | The number of segments used to create the circumference circle. |
| startangle | The position on the circle at which to start building the circumference. |
| fillangle | The number of degrees arround the circle to fill. |
| mirrorTexCoords | Allows you to display a horizontal mirror image of the texture. |
| texturescale | The scale of the texture to be used for the image artwork. |
| filtering | Allows you to specify the blend mode used for this texture when rendering. |
| Elements | |
| TexCoords | The texture coordinates for the CENTER of the CircleImage with the texture. |
| Functions | |
| Functions | |
| CircleImageSetTexture() | Sets the texture displayed on this image. |
| CircleImageSetFillParams() | Sets the fill parameters for the circle image. |
| CircleImageSetTextureScale() | Sets the textureScale value. |
| Functions | |
| Functions | |
| CircleImageSetTextureSlice() | Sets the texture slice displayed on this image. |
| CircleImageSetRotation() | Rotates the image around it’s center. |
This is the CircleImage xml definition.
| XML Tag | |
| Optional Attributes | These are optional. |
| texture | Name of the Ui Texture to display. |
| slice | Name of the <Slice> in the Ui Texture to display. |
| numsegments | The number of segments used to create the circumference circle. |
| startangle | The position on the circle at which to start building the circumference. |
| fillangle | The number of degrees arround the circle to fill. |
| mirrorTexCoords | Allows you to display a horizontal mirror image of the texture. |
| texturescale | The scale of the texture to be used for the image artwork. |
| filtering | Allows you to specify the blend mode used for this texture when rendering. |
| Elements | |
| TexCoords | The texture coordinates for the CENTER of the CircleImage with the texture. |
These are optional. You can use whichever apply to the CircleImage you are creating.
The number of segments used to create the circumference circle. The higher the number of segments the more circular the geomerty will look.
A number value between 3 and n.
The position on the circle at which to start building the circumference. 0 is the top.
A number value, representing the degrees of the start angle between 0 and 360.
The number of degrees arround the circle to fill.
A number value, representing the degrees of the fill angle between 0 and 360.
Allows you to display a horizontal mirror image of the texture. This swaps the topleft and bottom left coordinates with those used for the topright and bottomright of the image.
A boolean value.
| ”true” | Mirror the texture coords |
| ”false” | Use normal texture coordinates |
The scale of the texture to be used for the image artwork. This is multiplied by the image’s <Size> to determine the texture dimensions.
A number value. (1.0 = 100%)
Allows you to specify the blend mode used for this texture when rendering.
A boolean value.
| ”true” | Use Bilinear Filter filtering. |
| ”false” | Use Nearest Neighbor filtering. |
The texture coordinates for the CENTER of the CircleImage with the texture.
<TexCoords x="100" y="200" />
| x | The x pixel coordinate of the CENTER of the image. |
| y | The y pixel coordinate of the CENTER of the image. |
| x | 0 |
| y | 0 |
| Functions | |
| CircleImageSetTexture() | Sets the texture displayed on this image. |
| CircleImageSetFillParams() | Sets the fill parameters for the circle image. |
| CircleImageSetTextureScale() | Sets the textureScale value. |
Sets the texture displayed on this image.
| circleImageName | (string) The name of the CircleImage. |
| texture | (string) The name of the Ui Texture to display. |
| x | X coordinate in the Texture |
| y | Y coordinate in the Texture |
| nil | no return value |
CircleImageSetTexture("SomeImageWindow", "some_ui_texture" )Sets the fill parameters for the circle image.
| circleImageName | (string) The name of the CircleImage. |
| startAngle | (number) The angle at which to begin the circle’s circumference. (Degrees, 0-360 ) |
| fillAngle | (number) The angle to fill arround the circle. (Degrees, 0-360 ) |
| nil | no return value |
CircleImageSetFillParams( "MoraleWindowMoralStatus", startAngle, fillAngle )
Sets the textureScale value.
| circleImageName | (string) The name of the CircleImage. |
| textureScale | (number) The scale value to use on the image’s texture. (1.0 = 100%) |
| nil | no return value |
CircleImageSetTextureScale( "SomeCircleImage", 0.5 )
| Functions | |
| CircleImageSetTextureSlice() | Sets the texture slice displayed on this image. |
| CircleImageSetRotation() | Rotates the image around it’s center. |
Sets the texture slice displayed on this image.
| circleImageName | (string) The name of the CircleImage. |
| sliceName | (string) The name of the <Slice> to display in the CircleImage. |
| nil | no return value, regardless of success or failure |
CircleImageSetTextureSlice("SomeImageWindow", "some_ui_texture_slice" )