AtlasExtractionRequest.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using System;
using System.Collections.Generic;

namespace SiliconStudio.TextureConverter.Requests
{
    /// <summary>
    /// Request to extract one or every textures from an atlas.
    /// </summary>
    class AtlasExtractionRequest : IRequest
    {
        public override RequestType Type { get { return RequestType.AtlasExtraction; } }

        /// <summary>
        /// The name of the texture to extract
        /// </summary>
        public String Name { get; private set; }

        /// <summary>
        /// The minimum size of the smallest mipmap.
        /// </summary>
        public int MinimumMipMapSize { get; private set; }

        /// <summary>
        /// The extracted texture. 
        /// </summary>
        public TexImage Texture { get; set; }

        /// <summary>
        /// The extracted texture list.
        /// </summary>
        public List<TexImage> Textures { get; set; }


        /// <summary>
        /// Initializes a new instance of the <see cref="AtlasExtractionRequest"/> class. Used to extract a single texture.
        /// </summary>
        /// <param name="name">The name.</param>
        public AtlasExtractionRequest(string name, int minimimMipmapSize)
        {
            Name = name;
            MinimumMipMapSize = minimimMipmapSize;
            Texture = new TexImage();
        }


        /// <summary>
        /// Initializes a new instance of the <see cref="AtlasExtractionRequest"/> class. Used to extract every textures.
        /// </summary>
        public AtlasExtractionRequest(int minimimMipmapSize)
        {
            MinimumMipMapSize = minimimMipmapSize;
            Textures = new List<TexImage>();
        }
    }
}