RobustToolbox/Robust.Client/GameObjects/Components/Renderable/ISpriteComponent.cs

using System;
using System.Collections.Generic;
using Robust.Client.Graphics;
using Robust.Shared.Animations;
using Robust.Shared.GameObjects;
using Robust.Shared.Maths;
using Robust.Shared.Utility;

namespace Robust.Client.GameObjects
{
    public interface ISpriteComponent : IComponent, IAnimationProperties
    {
        void FrameUpdate(float delta);

        bool Visible { get; set; }

        /// <summary>
        ///     Z-index for drawing.
        /// </summary>
        int DrawDepth { get; set; }

        /// <summary>
        ///     A scale applied to all layers.
        /// </summary>
        [Animatable]
        Vector2 Scale { get; set; }

        Box2 Bounds { get; }

        /// <summary>
        ///     A rotation applied to all layers.
        /// </summary>
        [Animatable]
        Angle Rotation { get; set; }

        /// <summary>
        ///     Offset applied to all layers.
        /// </summary>
        [Animatable]
        Vector2 Offset { get; set; }

        /// <summary>
        ///     Color to multiply all layers with.
        /// </summary>
        [Animatable]
        Color Color { get; set; }

        /// <summary>
        /// All sprite rotation is locked, and will always be drawn upright on
        /// the screen, regardless of world or view orientation.
        /// </summary>
        bool NoRotation {get; set; }

        /// <summary>
        /// Enables overriding the calculated directional RSI state for this sprite.
        /// The state to use is defined in <see cref="DirectionOverride"/>.
        /// </summary>
        bool EnableDirectionOverride { get; set; }

        /// <summary>
        /// The directional RSI state that will always be displayed, regardless of orientation.
        /// </summary>
        Direction DirectionOverride { get; set; }

        // NOTE: The below are ALL designed to NOT throw exceptions ever,
        // instead making a bunch of noisy error logs.

        /// <summary>
        ///     The RSI that is currently used as "base".
        ///     Layers will fall back to this RSI if they do not have their own RSI set.
        /// </summary>
        RSI? BaseRSI { get; set; }

        ShaderInstance? PostShader { get; set; }
        uint RenderOrder { get; set; }
        bool IsInert { get; }

        Matrix3 GetLocalMatrix();

        /// <summary>
        ///     Sets a layer key to the layer map, creating it if it does not exist.
        /// </summary>
        /// <param name="key">The key for this entry.</param>
        /// <param name="layer">The layer this entry points to.</param>
        /// <exception cref="ArgumentOutOfRangeException">
        ///     Thrown if <paramref name="layer"/> does not exist.
        /// </exception>
        /// <exception cref="ArgumentNullException">
        ///     Thrown if <paramref name="key"/> is null.
        /// </exception>
        void LayerMapSet(object key, int layer);

        /// <summary>
        ///     Removes an entry from the layer map.
        /// </summary>
        /// <param name="key">The key to remove.</param>
        /// <exception cref="ArgumentNullException">
        ///     Thrown if <paramref name="key"/> is null.
        /// </exception>
        void LayerMapRemove(object key);

        /// <summary>
        ///     Gets the index of a layer specified in the layer map.
        /// </summary>
        /// <param name="key">The key for the entry to look up.</param>
        /// <exception cref="ArgumentNullException">
        ///     Thrown if <paramref name="key"/> is null.
        /// </exception>
        int LayerMapGet(object key);

        /// <exception cref="ArgumentNullException">
        ///     Thrown if <paramref name="key"/> is null.
        /// </exception>
        bool LayerMapTryGet(object key, out int layer, bool logError = false);

        /// <summary>
        ///     Create a new blank layer and add it to the layer map,
        ///     only if the key does not already exist on the layer map.
        /// </summary>
        /// <remarks>
        ///     This is useful to allow layer map configs to be defined in prototypes,
        ///     while still allowing code to create configs if they're absent.
        /// </remarks>
        /// <returns>Index of the new layer.</returns>
        int LayerMapReserveBlank(object key);

        /// <summary>
        ///     Adds a layer without texture (thus falling back to the error texture).
        ///     The layer defaults to invisible.
        /// </summary>
        /// <param name="newIndex">If not null, the index of this new layer.</param>
        /// <returns>Index of the new layer.</returns>
        int AddBlankLayer(int? newIndex = null);

        int AddLayer(Texture texture, int? newIndex = null);
        int AddLayer(string texturePath, int? newIndex = null);
        int AddLayer(ResourcePath texturePath, int? newIndex = null);
        int AddLayer(RSI.StateId stateId, int? newIndex = null);
        int AddLayerState(string stateId, int? newIndex = null);
        int AddLayer(RSI.StateId stateId, RSI rsi, int? newIndex = null);
        int AddLayerState(string stateId, RSI rsi, int? newIndex = null);
        int AddLayer(RSI.StateId stateId, string rsiPath, int? newIndex = null);
        int AddLayerState(string stateId, string rsiPath, int? newIndex = null);
        int AddLayer(RSI.StateId stateId, ResourcePath rsiPath, int? newIndex = null);
        int AddLayerState(string stateId, ResourcePath rsiPath, int? newIndex = null);
        int AddLayer(SpriteSpecifier specifier, int? newIndex = null);

        void RemoveLayer(int layer);
        void RemoveLayer(object layerKey);

        void LayerSetShader(int layer, ShaderInstance shader, string? prototype = null);
        void LayerSetShader(object layerKey, ShaderInstance shader, string? prototype = null);
        void LayerSetShader(int layer, string shaderName);
        void LayerSetShader(object layerKey, string shaderName);

        void LayerSetSprite(int layer, SpriteSpecifier specifier);
        void LayerSetSprite(object layerKey, SpriteSpecifier specifier);

        void LayerSetTexture(int layer, Texture texture);
        void LayerSetTexture(object layerKey, Texture texture);
        void LayerSetTexture(int layer, string texturePath);
        void LayerSetTexture(object layerKey, string texturePath);
        void LayerSetTexture(int layer, ResourcePath texturePath);
        void LayerSetTexture(object layerKey, ResourcePath texturePath);

        void LayerSetState(int layer, RSI.StateId stateId);
        void LayerSetState(object layerKey, RSI.StateId stateId);
        void LayerSetState(int layer, RSI.StateId stateId, RSI rsi);
        void LayerSetState(object layerKey, RSI.StateId stateId, RSI rsi);
        void LayerSetState(int layer, RSI.StateId stateId, string rsiPath);
        void LayerSetState(object layerKey, RSI.StateId stateId, string rsiPath);
        void LayerSetState(int layer, RSI.StateId stateId, ResourcePath rsiPath);
        void LayerSetState(object layerKey, RSI.StateId stateId, ResourcePath rsiPath);

        void LayerSetRSI(int layer, RSI rsi);
        void LayerSetRSI(object layerKey, RSI rsi);
        void LayerSetRSI(int layer, string rsiPath);
        void LayerSetRSI(object layerKey, string rsiPath);
        void LayerSetRSI(int layer, ResourcePath rsiPath);
        void LayerSetRSI(object layerKey, ResourcePath rsiPath);

        void LayerSetScale(int layer, Vector2 scale);
        void LayerSetScale(object layerKey, Vector2 scale);
        void LayerSetRotation(int layer, Angle rotation);
        void LayerSetRotation(object layerKey, Angle rotation);
        void LayerSetVisible(int layer, bool visible);
        void LayerSetVisible(object layerKey, bool visible);
        void LayerSetColor(int layer, Color color);

        void LayerSetColor(object layerKey, Color color);

        // Yes, I realize how silly it is to reference an enum in the concrete implementation.
        // I don't care.
        void LayerSetDirOffset(int layer, SpriteComponent.DirectionOffset offset);
        void LayerSetDirOffset(object layerKey, SpriteComponent.DirectionOffset offset);

        void LayerSetAnimationTime(int layer, float animationTime);
        void LayerSetAnimationTime(object layerKey, float animationTime);
        void LayerSetAutoAnimated(int layer, bool autoAnimated);
        void LayerSetAutoAnimated(object layerKey, bool autoAnimated);

        RSI.StateId LayerGetState(int layer);

        /// <summary>
        ///     Get the RSI used by a layer.
        /// </summary>
        RSI? LayerGetActualRSI(int layer);

        /// <summary>
        ///     Get the RSI used by a layer.
        /// </summary>
        RSI? LayerGetActualRSI(object layerKey);

        ISpriteLayer this[int layer] { get; }
        ISpriteLayer this[Index layer] { get; }
        ISpriteLayer this[object layerKey] { get; }

        IEnumerable<ISpriteLayer> AllLayers { get; }

        int GetLayerDirectionCount(ISpriteLayer layer);

        /// <summary>
        ///     Calculate the rotated sprite bounding box in world-space coordinates.
        /// </summary>
        Box2Rotated CalculateRotatedBoundingBox(Vector2 worldPosition, Angle worldRotation, Angle eye);
    }
}