//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated by a tool.
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

using Newtonsoft.Json;
using Shuttle.Api.AfterEffectsDTO.Properties;

namespace Shuttle.Api.AfterEffectsDTO.Items
{
    /// <summary>
    /// The CompItem object represents a composition, and allows you to manipulate and get information
    /// about it. Access the objects by position index number in a project’s ite m collection.
    /// </summary>
    public class CompItem : AVItem
    {
        /// <summary>
        /// The active camera, which is the front-most camera layer that is enabled. The value is null if the
        /// composition contains no enabled camera layers.
        /// </summary>
        [JsonProperty("activeCamera")]
        public Layer ActiveCamera { get; private set; }

        /// <summary>
        /// The background color of the composition. The three array values specify the red, green, and blue
        /// components of the color.
        /// </summary>
        [JsonProperty("bgColor")]
        public float[] BgColor { get; set; }

        /// <summary>
        /// The time set as the beginning of the composition, in seconds. This is the equivalent of the Start
        /// Timecode or Start Frame setting in the Composition Settings dialog box.
        /// </summary>
        [JsonProperty("displayStartTime")]
        public float DisplayStartTime { get; set; }

        /// <summary>
        /// When true, Draft 3D mode is enabled for the Composition panel. This corresponds to the value of
        /// the Draft 3D button in the Composition panel.
        /// </summary>
        [JsonProperty("draft3d")]
        public bool Draft3d { get; set; }

        /// <summary>
        /// When true, indicates that the composition uses drop-frame timecode. When false, indicates
        /// non-drop-frame timecode. This corresponds to the setting in the Composition Settings dialog box.
        /// </summary>
        [JsonProperty("dropFrame")]
        public bool DropFrame { get; set; }

        /// <summary>
        /// When true, frame blending is enabled for this Composition. Corresponds to the value of the Frame
        /// Blending button in the Composition panel.
        /// </summary>
        [JsonProperty("frameBlending")]
        public bool FrameBlending { get; set; }

        /// <summary>
        /// When true, only layers with shy set to false are shown in the Timeline panel. When false, all
        /// layers are visible, including those whose shy value is true. Corresponds to the value of the Hide All
        /// Shy Layers button in the Composition panel.
        /// </summary>
        [JsonProperty("hideShyLayers")]
        public bool HideShyLayers { get; set; }

        /// <summary>
        /// A LayerCollection object that contains all the Layer objects for layers in this composition.
        /// </summary>
        [JsonProperty("layers")]
        public Layer[] Layers { get; private set; } = new Layer[0];

        /// <summary>
        /// A PropertyGroup object that contains all a composition’s markers. Composition marker scripting has
        /// the same functionality as layer markers. See MarkerValue object
        /// </summary>
        [JsonProperty("markerProperty")]
        public PropertyGroup MarkerProperty { get; private set; }

        /// <summary>
        /// When true, motion blur is enabled for the composition. Corresponds to the value of the Motion Blur
        /// button in the Composition panel.
        /// </summary>
        [JsonProperty("motionBlur")]
        public bool MotionBlur { get; set; }

        /// <summary>
        /// The maximum number of motion blur samples of 2D layer motion. This corresponds to the Adaptive
        /// Sample Limit setting in the Advanced tab of the Composition Settings dialog box.
        /// </summary>
        [JsonProperty("motionBlurAdaptiveSampleLimit")]
        public int MotionBlurAdaptiveSampleLimit { get; set; }

        /// <summary>
        /// The minimum number of motion blur samples per frame for Classic 3D layers, shape layers, and
        /// certain effects. This corresponds to the Samples Per Frame setting in the Advanced tab of the Composition
        /// Settings dialog box.
        /// </summary>
        [JsonProperty("motionBlurSamplesPerFrame")]
        public int MotionBlurSamplesPerFrame { get; set; }

        /// <summary>
        /// The number of properties in the Essential Graphics panel for the composition.
        /// </summary>
        [JsonProperty("motionGraphicsTemplateControllerCount")]
        public int MotionGraphicsTemplateControllerCount { get; private set; }

        /// <summary>
        /// Read or write the name property in the Essential Graphics panel for the composition.
        /// </summary>
        [JsonProperty("motionGraphicsTemplateName")]
        public string MotionGraphicsTemplateName { get; set; }

        /// <summary>
        /// The number of layers in the composition.
        /// </summary>
        [JsonProperty("numLayers")]
        public int NumLayers { get; private set; }

        /// <summary>
        /// When true, the frame rate of nested compositions is preserved in the current composition.
        /// Corresponds to the value of the “Preserve frame rate when nested or in render queue” option in the Advanced
        /// tab of the Composition Settings dialog box.
        /// </summary>
        [JsonProperty("preserveNestedFrameRate")]
        public bool PreserveNestedFrameRate { get; set; }

        /// <summary>
        /// When true, the resolution of nested compositions is preserved in the current composition.
        /// Corresponds to the value of the “Preserve Resolution When Nested” option in the Advanced tab of the
        /// Composition Settings dialog box.
        /// </summary>
        [JsonProperty("preserveNestedResolution")]
        public bool PreserveNestedResolution { get; set; }

        /// <summary>
        /// The current rendering plug-in module to be used to render this composition, as set in the Advanced
        /// tab of the Composition Settings dialog box. Allowed values are the members of CompItem.renderers.
        /// </summary>
        [JsonProperty("renderer")]
        public string Renderer { get; set; }

        /// <summary>
        /// The available rendering plug-in modules. Member strings reflect installed modules, as seen in the
        /// Advanced tab of the Composition Settings dialog box.
        /// </summary>
        [JsonProperty("renderers")]
        public string[] Renderers { get; private set; } = new string[0];

        /// <summary>
        /// The x and y downsample resolution factors for rendering the composition. The two values in the
        /// array specify how many pixels to skip when sampling; the first number controls horizontal sampling, the
        /// second controls vertical sampling. Full resolution is [1, 1], half resolution is [2, 2], and
        /// quarter resolution is [4, 4]. The default is [1, 1].
        /// </summary>
        [JsonProperty("resolutionFactor")]
        public int[] ResolutionFactor { get; set; }

        /// <summary>
        /// All of the selected layers in this composition. This is a 0-based array (the first object is at
        /// index 0).
        /// </summary>
        [JsonProperty("selectedLayers")]
        public Layer[] SelectedLayers { get; private set; } = new Layer[0];

        /// <summary>
        /// All of the selected properties (Property and PropertyGroup objects) in this composition. The first
        /// property is at index position 0.
        /// </summary>
        [JsonProperty("selectedProperties")]
        public Property[] SelectedProperties { get; private set; } = new Property[0];

        /// <summary>
        /// The shutter angle setting for the composition. This corresponds to the Shutter Angle setting in
        /// the Advanced tab of the Composition Settings dialog box.
        /// </summary>
        [JsonProperty("shutterAngle")]
        public int ShutterAngle { get; set; }

        /// <summary>
        /// The shutter phase setting for the composition. This corresponds to the Shutter Phase setting in
        /// the Advanced tab of the Composition Settings dialog box.
        /// </summary>
        [JsonProperty("shutterPhase")]
        public int ShutterPhase { get; set; }

        /// <summary>
        /// The duration of the work area in seconds. This is the difference of the start-point and end-point
        /// times of the Composition work area.
        /// </summary>
        [JsonProperty("workAreaDuration")]
        public float WorkAreaDuration { get; set; }

        /// <summary>
        /// The time when the Composition work area begins, in seconds.
        /// </summary>
        [JsonProperty("workAreaStart")]
        public float WorkAreaStart { get; set; }

        public override string ToString()
        {
            return Name;
        }
    }
}