CrabUI.CUISprite Class Reference

Wrapper Containing link to texture and drawing settings,
like SourceRedt, DrawMode, Effects, Rotation...
Multiple sprites can use the same texture. More...

Public Member Functions
override bool	Equals (object obj)
	CUISprite ()
	Default 1x1 white sprite.
	CUISprite (string path, Rectangle? sourceRect=null, string baseFolder=null)
	CUISprite (Texture2D texture, Rectangle? sourceRect=null)
object	Clone ()
override string	ToString ()

Static Public Member Functions
static CUISprite	FromVanilla (Sprite sprite)
	Creates a CUISprite from vanilla Sprite.
static CUISprite	FromName (string name)
	Uses vanilla GUI sprite from GUIStyle.ComponentStyles with this name.
static CUISprite	FromId (Identifier id)
static CUISprite	FromComponentStyle (GUIComponentStyle style, GUIComponent.ComponentState state=GUIComponent.ComponentState.None)
static CUISprite	Parse (string raw)
static CUISprite	ParseWithContext (string raw, string baseFolder=null)

Public Attributes
string	Path = ""
	Set when you load it from some path.
SpriteEffects	Effects
	None, FlipHorizontally, FlipVertically.
CUISpriteDrawMode	DrawMode
	Resize - will resize the sprite to component Wrap - will loop the texture Static - sprite ignores component position.
Rectangle	SourceRect
	Part of the texture that is drawn Won't work in Wrap mode becase it will loop the whole texture.
float	Rotation
	In radians.
Vector2	Origin
	Origin of rotation in pixels.

Properties
static Texture2D	BackupTexture [get]
	1x1 white texture
static CUISprite	Default [get]
	new Sprite that uses 1x1 default texture
Texture2D	Texture [get, set]
	The link to the texture Multiple sprites can use the same texture.
float	RotationAngle [get, set]
	In degree.
Vector2	RelativeOrigin [set]
	Origin of rotation in [0..1] of texture size.
Vector2	Offset [get, set]
	Draw offset from CUIComponent Position For your convenience also sets origin.
static string	BaseFolder [get, set]
	When you load sprite from file, relative paths are considered relative to barotrauma folder if BaseFolder != null sprite will check files in BaseFolder first Don't forget to set it back to null.

Detailed Description

Wrapper Containing link to texture and drawing settings,
like SourceRedt, DrawMode, Effects, Rotation...
Multiple sprites can use the same texture.

Definition at line 26 of file CUISprite.cs.

Constructor & Destructor Documentation

CUISprite() [1/3]

CrabUI.CUISprite.CUISprite

(

)

Default 1x1 white sprite.

Definition at line 166 of file CUISprite.cs.

    {
      Texture = BackupTexture;
      SourceRect = new Rectangle(0, 0, Texture.Width, Texture.Height);
    }

CUISprite() [2/3]

CrabUI.CUISprite.CUISprite	(	string	path,
		Rectangle?	sourceRect = null,
		string	baseFolder = null )

Definition at line 171 of file CUISprite.cs.

    {
      baseFolder ??= BaseFolder;
      string realpath = path;
 
      if (!System.IO.Path.IsPathRooted(path) && baseFolder != null)
      {
        string localPath = System.IO.Path.Combine(baseFolder, path);
        if (File.Exists(localPath)) realpath = localPath;
      }
 
      Path = path;
      Texture = CUI.TextureManager.GetTexture(realpath);
      if (sourceRect.HasValue) SourceRect = sourceRect.Value;
    }

CUISprite() [3/3]

CrabUI.CUISprite.CUISprite	(	Texture2D	texture,
		Rectangle?	sourceRect = null )

Definition at line 186 of file CUISprite.cs.

    {
      Texture = texture ?? BackupTexture;
      if (sourceRect.HasValue) SourceRect = sourceRect.Value;
    }

Member Function Documentation

Clone()

object CrabUI.CUISprite.Clone

(

)

Definition at line 192 of file CUISprite.cs.

    {
      CUISprite sprite = new CUISprite(Texture, SourceRect)
      {
        Path = this.Path,
        Rotation = this.Rotation,
        Offset = this.Offset,
        Origin = this.Origin,
        Effects = this.Effects,
        DrawMode = this.DrawMode,
      };
 
      return sprite;
    }

Equals()

override bool CrabUI.CUISprite.Equals

(

object

obj

)

Definition at line 112 of file CUISprite.cs.

    {
      if (obj is not CUISprite b) return false;
 
      return Texture == b.Texture &&
        SourceRect == b.SourceRect &&
        DrawMode == b.DrawMode &&
        Effects == b.Effects &&
        Rotation == b.Rotation &&
        Origin == b.Origin &&
        Offset == b.Offset;
    }

FromComponentStyle()

static CUISprite CrabUI.CUISprite.FromComponentStyle ( GUIComponentStyle style, GUIComponent.ComponentState state = GUIComponent::ComponentState::None )

static

Definition at line 150 of file CUISprite.cs.

    {
      return FromVanilla(style.Sprites[state].FirstOrDefault()?.Sprite);
    }

FromId()

static CUISprite CrabUI.CUISprite.FromId ( Identifier id )

static

Definition at line 142 of file CUISprite.cs.

    {
      GUIComponentStyle? style = GUIStyle.ComponentStyles[id];
      if (style == null) return Default;
 
      return FromComponentStyle(style);
    }

FromVanilla()

static CUISprite CrabUI.CUISprite.FromVanilla ( Sprite sprite )

static

Creates a CUISprite from vanilla Sprite.

Definition at line 128 of file CUISprite.cs.

    {
      if (sprite == null) return Default;
 
      return new CUISprite(sprite.Texture, sprite.SourceRect)
      {
        Path = sprite.FullPath,
      };
    }

Parse()

static CUISprite CrabUI.CUISprite.Parse ( string raw )

static

Definition at line 221 of file CUISprite.cs.

    {
      Dictionary<string, string> props = CUIExtensions.ParseKVPairs(raw);
 
      if (!props.ContainsKey("path")) return new CUISprite();
 
      CUISprite sprite = CUI.TextureManager.GetSprite(props["path"]);
      if (props.ContainsKey("mode"))
      {
        sprite.DrawMode = Enum.Parse<CUISpriteDrawMode>(props["mode"]);
      }
      if (props.ContainsKey("sourcerect"))
      {
        sprite.SourceRect = CUIExtensions.ParseRectangle(props["sourcerect"]);
      }
      else
      {
        sprite.SourceRect = new Rectangle(0, 0, sprite.Texture.Width, sprite.Texture.Height);
      }
      if (props.ContainsKey("effects"))
      {
        sprite.Effects = CUIExtensions.ParseSpriteEffects(props["effects"]);
      }
 
      if (props.ContainsKey("rotation"))
      {
        float r;
        float.TryParse(props["rotation"], out r);
        sprite.Rotation = r;
      }
 
      if (props.ContainsKey("offset"))
      {
        sprite.Offset = CUIExtensions.ParseVector2(props["offset"]);
      }
 
      if (props.ContainsKey("origin"))
      {
        sprite.Origin = CUIExtensions.ParseVector2(props["origin"]);
      }
 
      return sprite;
    }

ParseWithContext()

static CUISprite CrabUI.CUISprite.ParseWithContext ( string raw, string baseFolder = null )

static

Definition at line 266 of file CUISprite.cs.

    {
      Dictionary<string, string> props = CUIExtensions.ParseKVPairs(raw);
 
      if (!props.ContainsKey("path")) return new CUISprite();
 
      if (!System.IO.Path.IsPathRooted(props["path"]) && baseFolder != null)
      {
        string localPath = System.IO.Path.Combine(baseFolder, props["path"]);
 
        if (File.Exists(localPath)) props["path"] = localPath;
      }
 
      CUISprite sprite = CUI.TextureManager.GetSprite(props["path"]);
      if (props.ContainsKey("mode"))
      {
        sprite.DrawMode = Enum.Parse<CUISpriteDrawMode>(props["mode"]);
      }
      if (props.ContainsKey("sourcerect"))
      {
        sprite.SourceRect = CUIExtensions.ParseRectangle(props["sourcerect"]);
      }
      else
      {
        sprite.SourceRect = new Rectangle(0, 0, sprite.Texture.Width, sprite.Texture.Height);
      }
      if (props.ContainsKey("effects"))
      {
        sprite.Effects = CUIExtensions.ParseSpriteEffects(props["effects"]);
      }
 
      if (props.ContainsKey("rotation"))
      {
        float r;
        float.TryParse(props["rotation"], out r);
        sprite.Rotation = r;
      }
 
      if (props.ContainsKey("offset"))
      {
        sprite.Offset = CUIExtensions.ParseVector2(props["offset"]);
      }
 
      if (props.ContainsKey("origin"))
      {
        sprite.Origin = CUIExtensions.ParseVector2(props["origin"]);
      }
 
      return sprite;
    }

ToString()

override string CrabUI.CUISprite.ToString

(

)

Definition at line 207 of file CUISprite.cs.

    {
      string mode = DrawMode != CUISpriteDrawMode.Resize ? $", Mode: {DrawMode}" : "";
      string rect = SourceRect != Texture.Bounds ? $", SourceRect: {CUIExtensions.RectangleToString(SourceRect)}" : "";
      string effect = Effects != SpriteEffects.None ? $", Effects: {CUIExtensions.SpriteEffectsToString(Effects)}" : "";
 
      string rotation = Rotation != 0.0f ? $", Rotation: {Rotation}" : "";
      string offset = Offset != Vector2.Zero ? $", Offset: {CUIExtensions.Vector2ToString(Offset)}" : "";
      string origin = Origin != Vector2.Zero ? $", Origin: {CUIExtensions.Vector2ToString(Origin)}" : "";
 
      return $"{{ Path: {Path}{mode}{rect}{effect}{rotation}{offset}{origin} }}";
    }

Member Data Documentation

DrawMode

CUISpriteDrawMode CrabUI.CUISprite.DrawMode

Resize - will resize the sprite to component
Wrap - will loop the texture
Static - sprite ignores component position.

Definition at line 50 of file CUISprite.cs.

Effects

SpriteEffects CrabUI.CUISprite.Effects

None, FlipHorizontally, FlipVertically.

Definition at line 44 of file CUISprite.cs.

Origin

Vector2 CrabUI.CUISprite.Origin

Origin of rotation in pixels.

Definition at line 85 of file CUISprite.cs.

Path

string CrabUI.CUISprite.Path = ""

Set when you load it from some path.

Definition at line 40 of file CUISprite.cs.

Rotation

float CrabUI.CUISprite.Rotation

In radians.

Definition at line 73 of file CUISprite.cs.

SourceRect

Rectangle CrabUI.CUISprite.SourceRect

Part of the texture that is drawn
Won't work in Wrap mode becase it will loop the whole texture.

Definition at line 55 of file CUISprite.cs.

Property Documentation

BackupTexture

Texture2D CrabUI.CUISprite.BackupTexture

staticget

1x1 white texture

Definition at line 31 of file CUISprite.cs.

BaseFolder

string CrabUI.CUISprite.BaseFolder

staticgetset

When you load sprite from file, relative paths are considered relative to barotrauma folder
if BaseFolder != null sprite will check files in BaseFolder first Don't forget to set it back to null.

Definition at line 161 of file CUISprite.cs.

{ get; set; }

Default

CUISprite CrabUI.CUISprite.Default

staticget

new Sprite that uses 1x1 default texture

Definition at line 35 of file CUISprite.cs.

Offset

Vector2 CrabUI.CUISprite.Offset

getset

Draw offset from CUIComponent Position
For your convenience also sets origin.

Definition at line 102 of file CUISprite.cs.

    {
      get => offset;
      set
      {
        offset = value;
        RelativeOrigin = value;
      }
    }

RelativeOrigin

Vector2 CrabUI.CUISprite.RelativeOrigin

set

Origin of rotation in [0..1] of texture size.

Definition at line 89 of file CUISprite.cs.

    {
      set
      {
        if (Texture == null) return;
        Origin = new Vector2(value.X * Texture.Width, value.Y * Texture.Height);
      }
    }

RotationAngle

float CrabUI.CUISprite.RotationAngle

getset

In degree.

Definition at line 77 of file CUISprite.cs.

    {
      get => (float)(Rotation * 180 / Math.PI);
      set => Rotation = (float)(value * Math.PI / 180);
    }

Texture

Texture2D CrabUI.CUISprite.Texture

getset

The link to the texture
Multiple sprites can use the same texture.

Definition at line 61 of file CUISprite.cs.

    {
      get => texture;
      set
      {
        texture = value;
        SourceRect = new Rectangle(0, 0, texture.Width, texture.Height);
      }
    }

---

The documentation for this class was generated from the following file:

• CSharp/Client/CrabUI/Types/CUISprite.cs