Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET
Offers functions to define, access, and draw, a set of image components on a single graphical surface or Texture.

Namespace: Visual3D.UI
Assembly: Visual3D.UI (in Visual3D.UI.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

      
 C#  Visual Basic 
public class ImageSet
Public Class ImageSet

Members

               
 All Members  Constructors   Fields   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
ImageSet()()()()
Initializes a new instance of the ImageSet class
ImageSet(String, Texture)
Initializes a new instance of the ImageSet class
AddTexture(Texture)
AutoScale
Get/Set flag indicating whether to use auto-scaling for this Imageset.
Create(AssetFile)
Create(String, AssetFile)
Create(String, Texture)
DefaultImageFileName
DefineImage(String, String, ScreenRectangle, ScreenPoint)
Define a new Image for this Imageset.
DefineImage(String, String, ScreenPoint, ScreenSize, ScreenPoint)
Define a new Image for this Imageset.
Dispose()()()()
Cleans up resources in use.
Draw(String, ScreenRectangle, ScreenRectangle, Single, ScreenRectangle, ColorRect, Single)
Queues an area of the associated Texture the be drawn on the screen.
GetImage(String)
Gets the image with the specified name.
GetTexture(String)
Height
ImageCount
Gets the number of images defined for this Imageset.
IsImageDefined(String)
Returns true if an Image with the specified name exists.
Load(ImageSetData)
Initialize the image set with information taken from the specified data source.
Name
Name of the Imageset.
NativeResolution
Get/Set the native resolution for this Imageset.
NotifyScreenResolution(ScreenSize)
Notify the Imageset of the current (usually new) display resolution.
ReadBool(XmlNode, String)
ReadFloat(XmlNode, String)
ReadInt(XmlNode, String)
ReadString(XmlNode, String)
RemoveTexture(String)
UndefineAllImages()()()()
Removes the definitions for all Image objects currently defined in the Imageset.
UndefineImage(String)
Remove the definition for the Image with the specified name. If no such Image exists, nothing happens.
Width

Remarks

Imageset objects are a means by which a single graphical image (file, Texture, etc), can be split into a number of 'components' which can later be accessed via name. The components of an Imageset can queried for various details, and sent to the [!:Renderer] object for drawing.

Inheritance Hierarchy

System..::..Object
  Visual3D.UI..::..ImageSet

See Also