CrabUI.CUIComponent Class Reference

Base class for all components. More...

Inheritance diagram for CrabUI.CUIComponent:

Public Member Functions
void	AddAnimation (string name, CUIAnimation animation)
void	BlockChildrenAnimations ()
void	AttachTo (Item item, Action< Item, CUIComponent > callback=null)
void	AddCommand (string name, Action< object > action)
	Manually adds command.
void	RemoveCommand (string name)
void	DispatchUp (CUICommand command)
	Dispathes command up the component tree until someone consumes it.
void	DispatchDown (CUIData data)
	Dispathes command down the component tree until someone consumes it.
void	Execute (CUICommand command)
	Will execute action corresponding to this command.
virtual partial void	Draw (SpriteBatch spriteBatch)
	Here component should be drawn.
virtual partial void	DrawFront (SpriteBatch spriteBatch)
	Method for drawing something that should always be on top, e.g. resize handles.
virtual partial void	Draw (SpriteBatch spriteBatch)
virtual partial void	DrawFront (SpriteBatch spriteBatch)
	CUIComponent (float? x=null, float? y=null, float? w=null, float? h=null)
void	Dispose ()
virtual void	CleanUp ()
override string	ToString ()
void	PrintTree (string offset="")
void	Info (object msg, [CallerFilePath] string source="", [CallerLineNumber] int lineNumber=0)
	Prints component and then message.
CUIComponent	Remember (CUIComponent c, string name)
CUIComponent	Remember (CUIComponent c)
	If it already has AKA.
CUIComponent	Forget (string name)
CUIComponent	Forget (CUIComponent c)
	If it already has AKA.
virtual CUIComponent	Get (string name)
	Returns memorized component by name.
T	Get< T > (string name)
void	CascadeRefresh ()
virtual bool	IsPointOnTransparentPixel (Vector2 point)
virtual bool	ShouldInvoke (CUIInput e)
void	InvokeOnLayoutUpdated ()
record	CompareResult (bool equal, string firstMismatch="")
CUIComponent	Clone ()
void	SaveStateAs (string name)
void	LoadState (string name)
void	ForgetState (string name)
void	ApplyState (CUIComponent state)
virtual XElement	ToXML (CUIAttribute propAttribute=CUIAttribute.CUISerializable)
virtual void	FromXML (XElement element, string baseFolder=null)
string	Serialize (CUIAttribute propAttribute=CUIAttribute.CUISerializable)
void	LoadSelfFromFile (string path, bool searchForSpritesInTheSameFolder=true, bool saveAfterLoad=false)
void	LoadFromTheSameFile ()
void	SaveToTheSamePath ()
void	SaveToFile (string path, CUIAttribute propAttribute=CUIAttribute.CUISerializable)
virtual void	Hydrate ()
	Experimental method Here you can add data/ callbacks/ save stuff to variables after loading a xml skeletom.
virtual CUIComponent	Append (CUIComponent child, string name=null, [CallerMemberName] string memberName="")
	Adds children to the end of the list.
virtual CUIComponent	Prepend (CUIComponent child, string name=null, [CallerMemberName] string memberName="")
	Adds children to the begining of the list.
virtual CUIComponent	Insert (CUIComponent child, int index, string name=null, [CallerMemberName] string memberName="")
void	RemoveSelf ()
CUIComponent	RemoveChild (CUIComponent child, [CallerMemberName] string memberName="")
void	RemoveAllChildren ([CallerMemberName] string memberName="")
void	MoveToFront ()
	Moves component to front in Parent.Children which makes it render after other childs.

Static Public Member Functions
static void	RunRecursiveOn (CUIComponent component, Action< CUIComponent > action)
	designed to be versatile, in fact never used
static void	ForEach (Action< CUIComponent > action)
static IEnumerable< Type >	GetClassHierarchy (Type type)
static IEnumerable< Type >	GetReverseClassHierarchy (Type type)
static bool	DeepCompareVerbose (CUIComponent a, CUIComponent b)
static CompareResult	DeepCompare (CUIComponent a, CUIComponent b)
static CUIComponent	Deserialize (string raw, string baseFolder=null)
static CUIComponent	Deserialize (XElement e, string baseFolder=null)
static CUIComponent	LoadFromFile (string path, bool searchForSpritesInTheSameFolder=true, bool saveAfterLoad=false)
static T	LoadFromFile< T > (string path, bool searchForSpritesInTheSameFolder=true, bool saveAfterLoad=false)

Public Attributes
Indexer< string, CUIAnimation >	Animations
Dictionary< string, List< CUIComponent > >	DataTargets = new()
	Consumers of emmited data, updates on tree change.
bool	Disposed
bool	ignoreDebug
	For debug frame itself.
CUIResizeHandle	LeftResizeHandle = new CUIResizeHandle(new Vector2(0, 1), new CUIBool2(false, false))
CUIResizeHandle	RightResizeHandle = new CUIResizeHandle(new Vector2(1, 1), new CUIBool2(true, false))

Static Public Attributes
static Dictionary< int, WeakReference< CUIComponent > >	ComponentsById = new()
static WeakCatalog< Type, CUIComponent >	ComponentsByType = new()
static GUIButton	dummyComponent
	This is used to trick vanilla GUI into believing that mouse is hovering some component and block clicks.

Protected Member Functions
void	ExtractProps (XElement element, string baseFolder=null)
void	PackProps (XElement element, CUIAttribute propAttribute=CUIAttribute.CUISerializable)
virtual void	PassPropsToChild (CUIComponent child)
	Pass props like ZIndex, Visible to a new child.

Protected Attributes
CUILayout	layout
CUINullVector2	forsedSize
float	scale = 1f
Color[]	TextureData
	Buffer for texture data, for IgnoreTransparent checks.
bool	disabled

Properties
AttachedItemHandle	AttachedItemHandle [get, set]
string	Command [get, set]
	This command will be dispatched up when some component specific event happens.
string	Consumes [get, set]
	Will consume data with this name.
bool	ReflectCommands [get, set]
bool	RetranslateCommands [get, set]
ObservableCollection< string >	Emits [get, set]
	Optimization to data flow If not empty component will search for consumers of the data and pass it directly to them instead of broadcasting it.
Dictionary< string, Action< object > >	Commands = new() [get, set]
	All commands.
static IEnumerable< CUIComponent >	AllComponents [get]
bool	Debug [get, set]
bool	IgnoreDebug [get, set]
string	AKA [get, set]
	Parent can memorize it's children by their names, AKA.
Dictionary< string, CUIComponent >	NamedComponents = new() [get, set]
	All memorized components.
CUIComponent	this[string name] [get, set]
	You can access NamedComponents with this indexer.
bool	ConsumeMouseClicks [get, set]
bool	ConsumeDragAndDrop [get, set]
bool	ConsumeSwipe [get, set]
bool	ConsumeMouseScroll [get, set]
Action< double >	AddOnUpdate [set]
Action< CUIInput >	AddOnMouseLeave [set]
Action< CUIInput >	AddOnMouseEnter [set]
Action< CUIInput >	AddOnMouseDown [set]
Action< CUIInput >	AddOnMouseUp [set]
Action< CUIInput >	AddOnMouseMove [set]
Action< CUIInput >	AddOnMouseOn [set]
Action< CUIInput >	AddOnMouseOff [set]
Action< CUIInput >	AddOnClick [set]
Action< CUIInput >	AddOnDClick [set]
Action< CUIInput >	AddOnScroll [set]
Action< float, float >	AddOnDrag [set]
Action< float, float >	AddOnSwipe [set]
Action< CUIInput >	AddOnKeyDown [set]
Action< CUIInput >	AddOnKeyUp [set]
Action< CUIInput >	AddOnTextInput [set]
Action	AddOnFocus [set]
Action	AddOnFocusLost [set]
bool	Draggable [get, set]
bool	Focusable [get, set]
bool	Resizible [get, set]
bool	ResizibleLeft [get, set]
bool	ResizibleRight [get, set]
CUIBool2	ResizeDirection [get, set]
bool	Swipeable [get, set]
virtual CUILayout	Layout [get, set]
Dictionary< string, CUIComponent >	States = new() [get, set]
	State is just a clone component with copies of all props.
string	SavePath [get, set]
int	ID [get, set]
	Global ID, unique for component.
CUIMainComponent	MainComponent [get, set]
	Link to CUIMainComponent, passed to children.
bool	Focused [get, set]
bool	BackgroundVisible [get, set]
	BackgroundColor != Color.Transparent.
bool	OutlineVisible [get, set]
bool	MouseOver [get, set]
bool	MousePressed [get, set]
CUINullVector2	ForcedMinSize [get, set]
	This is used by text to prevent resizing beyond that and works as AbsoluteMin.
float	Scale [get, set]
	This is set by ChildrenOffset when zooming, and iirc consumed by text to adjust text scale.
CUIRect	BorderBox [get, set]
	Calculated Prop, Real + BorderThickness.
CUIRect	OutlineBox [get, set]
CUIRect	Real [get, set]
	Calculated prop, position on real screen in pixels Should be fully calculated after CUIMainComponent.Update.
CUIStyle	Style [get, set]
	Allows you to assing parsable string or link to CUIPalette to any prop It's indexable, so you can access it like this: component.Style["BackgroundColor"] = "cyan" if value starts with "CUIPalette." it will extract the value from palette e.g. component.Style["BackgroundColor"] = "CUIPalette.DarkBlue.Secondary.On"
CUIStyle	ResolvedStyle [get, set]
List< CUIComponent >	Children = new() [get, set]
CUIComponent?	Parent [get, set]
IEnumerable< CUIComponent >	AddChildren [set]
	Allows you to add array of children.
CUIComponentProps	CUIProps = new() [get, set]
	Just a wrapper for CUIProps idk how to separate them better.
Vector2	Padding [get, set]
	Used for text, should be in CUITextBlock really.
CUISprite	BorderSprite = CUISprite.Default [get, set]
	Should be one texture, not sprite sheet Or there would be no way to wrap it Top side will always point outwards.
CUIBorder	Border = new CUIBorder() [get, set]
	Container for Color and Thickness Border is drawn inside the component and will eat space from content If "by side" border prop != null then it'll take presidence.
CUIBorder	TopBorder [get, set]
CUIBorder	RigthBorder [get, set]
CUIBorder	BottomBorder [get, set]
CUIBorder	LeftBorder [get, set]
float	OutlineThickness = 1f [get, set]
Color	OutlineColor [get, set]
	Outline is like a border, but on the outside of the component.
CUISprite	BackgroundSprite [get, set]
	Will be drawn in background with BackgroundColor Default is solid white 1x1 texture.
bool	IgnoreTransparent [get, set]
	If true, mouse events on transparent pixels will be ignored Note: this will buffer texture data and potentially consume a lot of memory so use wisely.
Color	BackgroundColor [get, set]
	Color of BackgroundSprite, default is black If you're using custom sprite and don't see it make sure this color is not black.
float	Transparency [get, set]
PaletteOrder	Palette [get, set]
	This palette will be used to resolve palette styles Primary, Secondary, Tertiary, Quaternary.
PaletteOrder	DeepPalette [set]
Color	ResizeHandleColor = Color.White [get, set]
	Had to expose resize handle props, because it's not a real component and can't really use styles.
Color	ResizeHandleGrabbedColor = Color.Cyan [get, set]
SamplerState	SamplerState [get, set]
	don't
bool	HideChildrenOutsideFrame [get, set]
	Should children be cut off by scissor rect, this is just visual, it's not the same as culling.
bool	CullChildren [get, set]
	if child rect doesn't intersect with parent it won't be drawn and won't consume fps It also sets HideChildrenOutsideFrame
bool	UnCullable [get, set]
	It shouldn't be culled off even outside of parent bounds and even if parent demands so.
CUI3DOffset	ChildrenOffset [get, set]
	Will shift all children by this much, e.g. this is how scroll works It's also 3D.
Func< CUIRect, CUIBoundaries >	ChildrenBoundaries [get, set]
	Limits to children positions.
bool	Fixed [get, set]
	Should it ignore child offset?
Vector2	Anchor [get, set]
	this point of this component
Vector2?	ParentAnchor [get, set]
	will be attached to this point of parent
CUIBool2	Ghost [get, set]
	Ghost components don't affect layout.
int?	ZIndex [get, set]
	Components are drawn in order of their ZIndex Normally it's derived from component position in the tree, but this will override it.
bool	ResizeToSprite [get, set]
	If true component will set it's Absolute size to sprite texture size.
CUIBool2	FillEmptySpace [get, set]
	Will be resized to fill empty space in list components.
CUIBool2	FitContent [get, set]
	Will resize itself to fit components with absolute size, e.g. text.
CUINullRect	Absolute [get, set]
	Absolute size and position in pixels.
CUINullRect	AbsoluteMin [get, set]
CUINullRect	AbsoluteMax [get, set]
CUINullRect	Relative [get, set]
	Relative to parent size and position, [0..1].
CUINullRect	RelativeMin [get, set]
CUINullRect	RelativeMax [get, set]
CUINullRect	CrossRelative [get, set]
	It's like Relative, but to the opposite dimension E.g. Real.Width = CrossRelative.Width * Parent.Real.Height Handy for creating square things.
string	GridTemplateRows [get, set]
	Used in Grid, space separated Row sizes, either in pixels (123) or in % (123%)
string	GridTemplateColumns [get, set]
	Used in Grid, space separated Columns sizes, either in pixels (123) or in % (123%)
Point?	GridStartCell [get, set]
	Component will be placed in this cell in the grid component.
Point?	GridEndCell [get, set]
	And resized to fit cells from GridStartCell to GridEndCell.
Point?	GridCell [get, set]
	Sets both GridStartCell and GridEndCell at once.
object	Data [get, set]
	Arbitrary data.
virtual bool	Disabled [get, set]
	Usually means - non interactable, e.g. unclickable gray button.
bool	ShouldPassPropsToChildren = true [get, set]
	Some props (like visible) are autopassed to all new childs see PassPropsToChild.
bool	IgnoreParentVisibility [get, set]
	Don't inherit parent Visibility.
bool	IgnoreParentEventIgnorance [get, set]
	Don't inherit parent IgnoreEvents.
bool	IgnoreParentZIndex [get, set]
	Don't inherit parent ZIndex.
bool	IgnoreParentTransparency [get, set]
bool	Visible [get, set]
	Invisible components are not drawn, but still can be interacted with.
bool	IgnoreEvents [get, set]
	Won't react to mouse events.
bool	Revealed [get, set]
	Visible + !IgnoreEvents.
bool	Serializable = true [get, set]
	If false then this component and its children won't be serialized.
bool	SerializeChildren = true [get, set]
	Is this a serialization cutoff point Parent will serialize children down to this component and stop.
bool	MergeSerialization = false [get, set]
	If true it won't be deserialized, Instead its children will be detached and attached to the component with matching AKA on the parent.
bool	ReplaceSerialization = false [get, set]
	If true, deserialized component will replace existing component with the same AKA instead of creating a duplicate.
static bool	ForceSaveAllProps = false [get, set]
Properties inherited from CrabUI.ISimpleProps
Properties inherited from CrabUI.IListProps
Properties inherited from CrabUI.ISerializationProps

Events
Action< CUICommand >	OnAnyCommand
	this will be executed on any command
Action< CUIData >	OnAnyData
	Will be executed when receiving any data.
Action< Object >	OnConsume
	Happens when appropriate data is received.
Action	OnTreeChanged
Action< double >	OnUpdate
Action< CUIInput >	OnMouseLeave
Action< CUIInput >	OnMouseEnter
Action< CUIInput >	OnMouseDown
Action< CUIInput >	OnMouseUp
Action< CUIInput >	OnMouseMove
Action< CUIInput >	OnMouseOn
Action< CUIInput >	OnMouseOff
Action< CUIInput >	OnClick
Action< CUIInput >	OnDClick
Action< CUIInput >	OnScroll
Action< float, float >	OnDrag
Action< float, float >	OnSwipe
Action< CUIInput >	OnKeyDown
Action< CUIInput >	OnKeyUp
Action< CUIInput >	OnTextInput
Action	OnFocus
Action	OnFocusLost
Action	OnLayoutUpdated
Action	OnStyleApplied
	Use it to e.g. update component color.
Action< CUIComponent >	OnChildAdded
Action< CUIComponent >	OnChildRemoved

Detailed Description

Base class for all components.

Definition at line 19 of file Serialization Props.cs.

Constructor & Destructor Documentation

CUIComponent() [1/2]

CrabUI.CUIComponent.CUIComponent

(

)

Definition at line 208 of file CUIComponent.cs.

    {
      if (CUI.Disposed)
      {
        Disposed = true;
        return;
      }
 
      ID = MaxID++;
 
      ComponentsById[ID] = new WeakReference<CUIComponent>(this);
      ComponentsByType.Add(this.GetType(), this);
 
      Vitalize();
      VitalizeProps();
 
      SetupCommands();
 
      Layout = new CUILayoutSimple();
 
      SetupStyles();
      SetupAnimations();
    }

CUIComponent() [2/2]

CrabUI.CUIComponent.CUIComponent	(	float?	x = null,
		float?	y = null,
		float?	w = null,
		float?	h = null )

Definition at line 232 of file CUIComponent.cs.

                                                                                            : this()
    {
      Relative = new CUINullRect(x, y, w, h);
    }

Member Function Documentation

AddAnimation()

void CrabUI.CUIComponent.AddAnimation	(	string	name,
		CUIAnimation	animation )

Definition at line 31 of file CUIComponent.Animations.cs.

    {
      animation.Target = this;
      animations[name] = animation;
    }

AddCommand()

void CrabUI.CUIComponent.AddCommand	(	string	name,
		Action< object >	action )

Manually adds command.

Parameters

name
action

Append()

virtual CUIComponent CrabUI.CUIComponent.Append ( CUIComponent child, string name = null, [CallerMemberName] string memberName = "" )

virtual

Adds children to the end of the list.

Parameters

child
name	AKA

Returns

child

Definition at line 93 of file CUIComponent.Tree.cs.

    {
      if (child == null) return child;
 
      child.Parent = this;
      Children.Add(child);
      if (name != null) Remember(child, name);
 
      return child;
    }

ApplyState()

void CrabUI.CUIComponent.ApplyState

(

CUIComponent

state

)

Definition at line 85 of file CUIComponent.Serialization.cs.

    {
      Stopwatch sw = Stopwatch.StartNew();
      if (state == null) return;
 
      //TODO why not closest relative?
      Type targetType = state.GetType() == GetType() ? GetType() : typeof(CUIComponent);
 
      CUITypeMetaData meta = CUITypeMetaData.Get(targetType);
 
      //TODO Megacringe, fix it
      foreach (PropertyInfo pi in meta.Serializable.Values)
      {
        if (pi.PropertyType.IsValueType || pi.PropertyType == typeof(string))
        {
          pi.SetValue(this, pi.GetValue(state));
        }
        else
        {
          object value = pi.GetValue(state);
          if (value == null)
          {
            pi.SetValue(this, null);
            continue;
          }
 
          if (pi.PropertyType.IsAssignableTo(typeof(ICloneable)))
          {
            ICloneable cloneable = (ICloneable)pi.GetValue(state);
            object clone = cloneable.Clone();
            pi.SetValue(this, clone);
          }
          else
          {
            CUI.Info($"Ekhem, can't copy {pi} prop from {state} to {this} because it's not cloneable");
          }
        }
      }
 
      //TODO Megacringe, fix it
      foreach (PropertyInfo pi in meta.Serializable.Values)
      {
        if (pi.PropertyType.IsValueType && !object.Equals(pi.GetValue(state), pi.GetValue(this)))
        {
          pi.SetValue(this, pi.GetValue(state));
        }
      }
 
    }

BlockChildrenAnimations()

void CrabUI.CUIComponent.BlockChildrenAnimations

(

)

Definition at line 37 of file CUIComponent.Animations.cs.

    {
      foreach (CUIComponent child in Children)
      {
        foreach (CUIAnimation animation in child.animations.Values)
        {
          animation.Stop();
          animation.Blocked = true;
        }
        child.BlockChildrenAnimations();
      }
    }

CascadeRefresh()

void CrabUI.CUIComponent.CascadeRefresh

(

)

Definition at line 29 of file CUIComponent.Events.cs.

    {
      if (this is IRefreshable refreshable) refreshable.Refresh();
      Children.ForEach(c => c.CascadeRefresh());
    }

CleanUp()

virtual void CrabUI.CUIComponent.CleanUp ( )

virtual

Definition at line 244 of file CUIComponent.cs.

{ }

Clone()

CUIComponent CrabUI.CUIComponent.Clone

(

)

Definition at line 70 of file CUIComponent.Serialization.cs.

    {
      CUIComponent clone = new CUIComponent()
      {
        Unreal = true,
      };
      clone.ApplyState(this);
      return clone;
    }

CompareResult()

record CrabUI.CUIComponent.CompareResult	(	bool	equal,
		string	firstMismatch = "" )

Definition at line 22 of file CUIComponent.Serialization.cs.

    {
      public static implicit operator bool(CompareResult r) => r.equal;
    }

DeepCompare()

static CompareResult CrabUI.CUIComponent.DeepCompare ( CUIComponent a, CUIComponent b )

static

Definition at line 34 of file CUIComponent.Serialization.cs.

    {
      if (a.GetType() != b.GetType()) return new CompareResult(false, $"type mismatch: {a} | {b}");
 
      Type T = a.GetType();
      CUITypeMetaData meta = CUITypeMetaData.Get(T);
 
      foreach (var (key, pi) in meta.Serializable)
      {
        if (!object.Equals(pi.GetValue(a), pi.GetValue(b)))
        {
          return new CompareResult(false, $"{pi}: {a}{pi.GetValue(a)} | {b}{pi.GetValue(b)}");
        }
      }
 
      if (a.Children.Count != b.Children.Count)
      {
        return new CompareResult(false, $"child count mismatch: {a}{CUI.ArrayToString(a.Children)} | {b}{CUI.ArrayToString(b.Children)}");
      }
 
      for (int i = 0; i < a.Children.Count; i++)
      {
        CompareResult sub = DeepCompare(a.Children[i], b.Children[i]);
        if (!sub.equal) return sub;
      }
 
      return new CompareResult(true);
    }

DeepCompareVerbose()

static bool CrabUI.CUIComponent.DeepCompareVerbose ( CUIComponent a, CUIComponent b )

static

Definition at line 27 of file CUIComponent.Serialization.cs.

    {
      CompareResult result = DeepCompare(a, b);
      if (result.equal) CUI.Log($"{a} == {b}");
      else CUI.Log($"{result.firstMismatch}");
      return result.equal;
    }

Deserialize() [1/2]

static CUIComponent CrabUI.CUIComponent.Deserialize ( string raw, string baseFolder = null )

static

Definition at line 312 of file CUIComponent.Serialization.cs.

    {
      return Deserialize(XElement.Parse(raw));
    }

Deserialize() [2/2]

static CUIComponent CrabUI.CUIComponent.Deserialize ( XElement e, string baseFolder = null )

static

Definition at line 317 of file CUIComponent.Serialization.cs.

    {
      try
      {
        Type type = CUIReflection.GetComponentTypeByName(e.Name.ToString());
        if (type == null) return null;
 
        CUIComponent c = (CUIComponent)Activator.CreateInstance(type);
        // c.RemoveAllChildren();
        c.FromXML(e, baseFolder);
        CUIComponent.RunRecursiveOn(c, (component) => component.Hydrate());
 
        return c;
      }
      catch (Exception ex)
      {
        CUIDebug.Error(ex);
        return null;
      }
    }

DispatchDown()

void CrabUI.CUIComponent.DispatchDown

(

CUIData

data

)

Dispathes command down the component tree until someone consumes it.

Definition at line 195 of file CUIComponent.Commands.cs.

    {
      if (Emits.Contains(data.Name))
      {
        if (DataTargets.ContainsKey(data.Name))
        {
          foreach (CUIComponent target in DataTargets[data.Name])
          {
            target.OnConsume?.Invoke(data.Data);
          }
        }
      }
      else
      {
        if (Consumes == data.Name) OnConsume?.Invoke(data.Data);
        else if (OnAnyData != null) OnAnyData.Invoke(data);
        else
        {
          foreach (CUIComponent child in Children) child.DispatchDown(data);
        }
      }
    }

DispatchUp()

void CrabUI.CUIComponent.DispatchUp

(

CUICommand

command

)

Dispathes command up the component tree until someone consumes it.

Parameters

command

Definition at line 185 of file CUIComponent.Commands.cs.

    {
      if (OnAnyCommand != null) OnAnyCommand?.Invoke(command);
      else if (Commands.ContainsKey(command.Name)) Execute(command);
      else Parent?.DispatchUp(command);
    }

Dispose()

void CrabUI.CUIComponent.Dispose

(

)

Definition at line 238 of file CUIComponent.cs.

    {
      if (Disposed) return;
      CleanUp();
      Disposed = true;
    }

Draw() [1/2]

virtual partial void CrabUI.CUIComponent.Draw ( SpriteBatch spriteBatch )

virtual

Here component should be drawn.

Parameters

spriteBatch

Reimplemented in CrabUI.CUIButton, CrabUI.CUIMagnifyingGlass, CrabUI.CUIMainComponent, CrabUI.CUISlider, CrabUI.CUITextBlock, CrabUI.CUITextInput, and CrabUI.CUIToggleButton.

Draw() [2/2]

virtual partial void CrabUI.CUIComponent.Draw ( SpriteBatch spriteBatch )

virtual

Reimplemented in CrabUI.CUIButton, CrabUI.CUIMagnifyingGlass, CrabUI.CUIMainComponent, CrabUI.CUISlider, CrabUI.CUITextBlock, CrabUI.CUITextInput, and CrabUI.CUIToggleButton.

Definition at line 145 of file CUIComponent.cs.

    {
      if (BackgroundVisible) CUI.DrawRectangle(spriteBatch, Real, BackgroundColor * Transparency, BackgroundSprite);
 
      CUI.DrawBorders(spriteBatch, this);
      // if (Border.Visible) GUI.DrawRectangle(spriteBatch, BorderBox.Position, BorderBox.Size, Border.Color, thickness: Border.Thickness);
 
      if (OutlineVisible) GUI.DrawRectangle(spriteBatch, OutlineBox.Position, OutlineBox.Size, OutlineColor, thickness: OutlineThickness);
    }

DrawFront() [1/2]

virtual partial void CrabUI.CUIComponent.DrawFront ( SpriteBatch spriteBatch )

virtual

Method for drawing something that should always be on top, e.g. resize handles.

Parameters

spriteBatch

DrawFront() [2/2]

virtual partial void CrabUI.CUIComponent.DrawFront ( SpriteBatch spriteBatch )

virtual

Definition at line 155 of file CUIComponent.cs.

    {
      LeftResizeHandle.Draw(spriteBatch);
      RightResizeHandle.Draw(spriteBatch);
 
      if (DebugHighlight)
      {
        CUI.DrawTexture(spriteBatch, Real, CUITextureManager.Checkers, Color.White * 0.5f, CUISpriteDrawMode.Static);
      }
    }

Execute()

void CrabUI.CUIComponent.Execute

(

CUICommand

command

)

Will execute action corresponding to this command.

Parameters

commandName

Definition at line 222 of file CUIComponent.Commands.cs.

    {
      Commands.GetValueOrDefault(command.Name)?.Invoke(command.Data);
    }

ExtractProps()

void CrabUI.CUIComponent.ExtractProps ( XElement element, string baseFolder = null )

protected

Definition at line 230 of file CUIComponent.Serialization.cs.

    {
      Type type = GetType();
 
      CUITypeMetaData meta = CUITypeMetaData.Get(type);
 
      foreach (XAttribute attribute in element.Attributes())
      {
        if (!meta.Serializable.ContainsKey(attribute.Name.ToString()))
        {
          CUI.Warning($"Can't parse prop {attribute.Name} in {type.Name} because type metadata doesn't contain that prop (is it a property? fields aren't supported yet)");
          continue;
        }
 
        PropertyInfo prop = meta.Serializable[attribute.Name.ToString()];
 
        try
        {
          if (prop.PropertyType == typeof(CUISprite) && baseFolder != null)
          {
            prop.SetValue(this, CUISprite.ParseWithContext(attribute.Value, baseFolder));
          }
          else
          {
            prop.SetValue(this, CUIParser.Parse(attribute.Value, prop.PropertyType, false));
          }
        }
        catch (Exception e)
        {
          CUI.Warning($"Can't parse {attribute.Value} into {prop.PropertyType.Name}\n{e}");
        }
      }
    }

ForEach()

static void CrabUI.CUIComponent.ForEach ( Action< CUIComponent > action )

static

Definition at line 84 of file CUIComponent.cs.

    {
      foreach (int id in ComponentsById.Keys)
      {
        CUIComponent component = null;
        ComponentsById[id].TryGetTarget(out component);
        if (component is not null) action(component);
      }
    }

Forget() [1/2]

CUIComponent CrabUI.CUIComponent.Forget

(

CUIComponent

c

)

If it already has AKA.

Definition at line 109 of file CUIComponent.Debug.cs.

    {
      if (c?.AKA != null) NamedComponents.Remove(c.AKA);
      return c;
    }

Forget() [2/2]

CUIComponent CrabUI.CUIComponent.Forget

(

string

name

)

Definition at line 99 of file CUIComponent.Debug.cs.

    {
      if (name == null) return null;
      CUIComponent c = NamedComponents.GetValueOrDefault(name);
      NamedComponents.Remove(name);
      return c;
    }

FromXML()

virtual void CrabUI.CUIComponent.FromXML ( XElement element, string baseFolder = null )

virtual

Definition at line 170 of file CUIComponent.Serialization.cs.

    {
      //RemoveAllChildren();
 
      foreach (XElement childElement in element.Elements())
      {
        Type childType = CUIReflection.GetComponentTypeByName(childElement.Name.ToString());
        if (childType == null) continue;
 
        CUIComponent child = (CUIComponent)Activator.CreateInstance(childType);
        child.FromXML(childElement, baseFolder);
 
        if (child.MergeSerialization)
        {
          try
          {
            if (child.AKA == null || !this.NamedComponents.ContainsKey(child.AKA))
            {
              CUI.Warning($"Can't merge {child} into {this}");
              CUI.Warning($"Merge deserialization requre matching AKA");
              this.Append(child, child.AKA);
            }
            else
            {
              List<CUIComponent> children = new List<CUIComponent>(child.Children);
              foreach (CUIComponent c in children)
              {
                this[child.AKA].Append(c);
              }
            }
          }
          catch (Exception e)
          {
            CUI.Warning($"Merge deserialization of {child} into {this}[{child.AKA}] failed");
            CUI.Warning(e.Message);
          }
        }
        else
        {
          if (child.AKA != null && this.NamedComponents.ContainsKey(child.AKA))
          {
            if (child.ReplaceSerialization)
            {
              this.RemoveChild(this[child.AKA]);
            }
            else
            {
              CUI.Warning($"{this} already contains {child.AKA}, so deserialization will create a duplicate\nTry using ReplaceSerialization or MergeSerialization");
            }
          }
 
          this.Append(child, child.AKA);
        }
 
        //CUI.Log($"{this}[{child.AKA}] = {child} ");
      }
 
      ExtractProps(element, baseFolder);
    }

Get()

virtual CUIComponent CrabUI.CUIComponent.Get ( string name )

virtual

Returns memorized component by name.

Parameters

name

Returns

Definition at line 135 of file CUIComponent.Debug.cs.

    {
      if (name == null) return null;
      if (NamedComponents.ContainsKey(name)) return NamedComponents[name];
 
      CUIComponent component = this;
      string[] names = name.Split('.');
 
      foreach (string n in names)
      {
        component = component.NamedComponents.GetValueOrDefault(n);
 
        if (component == null)
        {
          CUI.Warning($"Failed to Get {name} from {this}, there's no {n}");
          break;
        }
      }
 
      return component;
    }

Get< T >()

T CrabUI.CUIComponent.Get< T >

(

string

name

)

Type Constraints

T

:

CUIComponent

GetClassHierarchy()

static IEnumerable< Type > CrabUI.CUIComponent.GetClassHierarchy ( Type type )

static

Definition at line 94 of file CUIComponent.cs.

    {
      while (type != typeof(Object) && type != null)
      {
        yield return type;
        type = type.BaseType;
      }
    }

Hydrate()

virtual void CrabUI.CUIComponent.Hydrate ( )

virtual

Experimental method
Here you can add data/ callbacks/ save stuff to variables
after loading a xml skeletom.

Definition at line 449 of file CUIComponent.Serialization.cs.

    {
 
    }

Info()

void CrabUI.CUIComponent.Info	(	object	msg,
		[CallerFilePath] string	source = "",
		[CallerLineNumber] int	lineNumber = 0 )

Prints component and then message.

Parameters

msg
source
lineNumber

Definition at line 64 of file CUIComponent.Debug.cs.

    {
      var fi = new FileInfo(source);
 
      CUI.Log($"{fi.Directory.Name}/{fi.Name}:{lineNumber}", Color.Yellow * 0.5f);
      CUI.Log($"{this} {msg ?? "null"}", Color.Yellow);
    }

Insert()

virtual CUIComponent CrabUI.CUIComponent.Insert ( CUIComponent child, int index, string name = null, [CallerMemberName] string memberName = "" )

virtual

Definition at line 121 of file CUIComponent.Tree.cs.

    {
      if (child == null) return child;
 
      child.Parent = this;
      index = Math.Clamp(index, 0, Children.Count);
      Children.Insert(index, child);
      if (name != null) Remember(child, name);
 
      return child;
    }

IsPointOnTransparentPixel()

virtual bool CrabUI.CUIComponent.IsPointOnTransparentPixel ( Vector2 point )

virtual

Definition at line 76 of file CUIComponent.Events.cs.

    {
      if (BackgroundSprite.DrawMode != CUISpriteDrawMode.Resize) return true;
 
      //TODO hangle case where offset != sprite.origin
      Vector2 RotationCenter = new Vector2(
        BackgroundSprite.Offset.X * Real.Width,
        BackgroundSprite.Offset.Y * Real.Height
      );
 
      Vector2 v = (point - Real.Position - RotationCenter).Rotate(-BackgroundSprite.Rotation) + RotationCenter;
 
      float x = v.X / Real.Width;
      float y = v.Y / Real.Height;
 
      Rectangle bounds = BackgroundSprite.Texture.Bounds;
      Rectangle SourceRect = BackgroundSprite.SourceRect;
 
      int textureX = (int)Math.Round(SourceRect.X + x * SourceRect.Width);
      int textureY = (int)Math.Round(SourceRect.Y + y * SourceRect.Height);
 
      if (textureX < SourceRect.X || (SourceRect.X + SourceRect.Width - 1) < textureX) return true;
      if (textureY < SourceRect.Y || (SourceRect.Y + SourceRect.Height - 1) < textureY) return true;
 
      Color cl = TextureData[textureY * bounds.Width + textureX];
 
      return cl.A == 0;
    }

LoadFromFile()

static CUIComponent CrabUI.CUIComponent.LoadFromFile ( string path, bool searchForSpritesInTheSameFolder = true, bool saveAfterLoad = false )

static

Definition at line 359 of file CUIComponent.Serialization.cs.

    {
      try
      {
        XDocument xdoc = XDocument.Load(path);
        CUIComponent result;
        if (searchForSpritesInTheSameFolder)
        {
          result = Deserialize(xdoc.Root, Path.GetDirectoryName(path));
        }
        else result = Deserialize(xdoc.Root);
 
        result.SavePath = path;
 
        if (saveAfterLoad) result.SaveToTheSamePath();
 
        return result;
      }
      catch (Exception ex)
      {
        CUIDebug.Error(ex);
        return null;
      }
    }

LoadFromFile< T >()

static T CrabUI.CUIComponent.LoadFromFile< T > ( string path, bool searchForSpritesInTheSameFolder = true, bool saveAfterLoad = false )

static

Type Constraints

T

:

CUIComponent

Definition at line 384 of file CUIComponent.Serialization.cs.

                                                                                                                                  : CUIComponent
    {
      try
      {
        XDocument xdoc = XDocument.Load(path);
        T result;
        if (searchForSpritesInTheSameFolder)
        {
          result = (T)Deserialize(xdoc.Root, Path.GetDirectoryName(path));
        }
        else result = (T)Deserialize(xdoc.Root);
 
        result.SavePath = path;
 
        if (saveAfterLoad) result.SaveToTheSamePath();
 
        return result;
      }
      catch (Exception ex)
      {
        CUIDebug.Error(ex);
        return null;
      }
    }

LoadFromTheSameFile()

void CrabUI.CUIComponent.LoadFromTheSameFile

(

)

Definition at line 409 of file CUIComponent.Serialization.cs.

    {
      if (SavePath == null)
      {
        CUI.Warning($"Can't load {this} from The Same Path, SavePath is null");
        return;
      }
      LoadSelfFromFile(SavePath);
    }

LoadSelfFromFile()

void CrabUI.CUIComponent.LoadSelfFromFile	(	string	path,
		bool	searchForSpritesInTheSameFolder = true,
		bool	saveAfterLoad = false )

Definition at line 338 of file CUIComponent.Serialization.cs.

    {
      try
      {
        XDocument xdoc = XDocument.Load(path);
 
        RemoveAllChildren();
        if (searchForSpritesInTheSameFolder) FromXML(xdoc.Root, Path.GetDirectoryName(path));
        else FromXML(xdoc.Root);
 
        CUIComponent.RunRecursiveOn(this, (component) => component.Hydrate());
        SavePath = path;
 
        if (saveAfterLoad) SaveToTheSamePath();
      }
      catch (Exception ex)
      {
        CUI.Warning(ex);
      }
    }

MoveToFront()

void CrabUI.CUIComponent.MoveToFront

(

)

Moves component to front in Parent.Children which makes it render after other childs.

Definition at line 201 of file CUIComponent.Tree.cs.

    {
      if (Parent == null) return;
 
      Parent.Children.Remove(this);
      Parent.Children.Add(this);
      TreeChanged = true;
    }

PackProps()

void CrabUI.CUIComponent.PackProps ( XElement element, CUIAttribute propAttribute = CUIAttribute::CUISerializable )

protected

Definition at line 265 of file CUIComponent.Serialization.cs.

    {
      Type type = GetType();
      CUITypeMetaData meta = CUITypeMetaData.Get(type);
 
      SortedDictionary<string, PropertyInfo> props = propAttribute switch
      {
        CUIAttribute.CUISerializable => meta.Serializable,
        CUIAttribute.Calculated => meta.Calculated,
        _ => meta.Serializable,
      };
 
      foreach (string key in props.Keys)
      {
        try
        {
          object value = props[key].GetValue(this);
          // it's default value for this prop
          if (!ForceSaveAllProps && meta.Default != null && Object.Equals(value, CUIReflection.GetNestedValue(meta.Default, key)))
          {
            continue;
          }
 
          element?.SetAttributeValue(key, CUIParser.Serialize(value, false));
        }
        catch (Exception e)
        {
          CUI.Warning($"Failed to serialize prop: {e.Message}");
          CUI.Warning($"{key} in {this}");
        }
      }
    }

PassPropsToChild()

virtual void CrabUI.CUIComponent.PassPropsToChild ( CUIComponent child )

protectedvirtual

Pass props like ZIndex, Visible to a new child.

Parameters

child

Definition at line 187 of file CUIComponent.Tree.cs.

    {
      if (!ShouldPassPropsToChildren) return;
 
      //child.Palette = Palette;
      if (ZIndex.HasValue && !child.IgnoreParentZIndex) child.ZIndex = ZIndex.Value + 1;
      if (IgnoreEvents && !child.IgnoreParentEventIgnorance) child.IgnoreEvents = true;
      if (!Visible && !child.IgnoreParentVisibility) child.Visible = false;
    }

Prepend()

virtual CUIComponent CrabUI.CUIComponent.Prepend ( CUIComponent child, string name = null, [CallerMemberName] string memberName = "" )

virtual

Adds children to the begining of the list.

Parameters

child
name	AKA

Returns

child

Definition at line 110 of file CUIComponent.Tree.cs.

    {
      if (child == null) return child;
 
      child.Parent = this;
      Children.Insert(0, child);
      if (name != null) Remember(child, name);
 
      return child;
    }

PrintTree()

void CrabUI.CUIComponent.PrintTree

(

string

offset = ""

)

Definition at line 49 of file CUIComponent.Debug.cs.

    {
      CUI.Log($"{offset}{this}");
      foreach (CUIComponent child in Children)
      {
        child.PrintTree(offset + "|    ");
      }
    }

Remember() [1/2]

CUIComponent CrabUI.CUIComponent.Remember

(

CUIComponent

c

)

If it already has AKA.

Definition at line 93 of file CUIComponent.Debug.cs.

    {
      if (c.AKA != null) NamedComponents[c.AKA] = c;
      return c;
    }

Remember() [2/2]

CUIComponent CrabUI.CUIComponent.Remember	(	CUIComponent	c,
		string	name )

Definition at line 84 of file CUIComponent.Debug.cs.

    {
      NamedComponents[name] = c;
      c.AKA = name;
      return c;
    }

RemoveAllChildren()

void CrabUI.CUIComponent.RemoveAllChildren

(

[CallerMemberName] string

memberName = ""

)

Definition at line 160 of file CUIComponent.Tree.cs.

    {
      foreach (CUIComponent c in Children)
      {
        if (this != null) // kek
        {
          c.TreeChanged = true;
          c.OnPropChanged();
          //Forget(c);
          //Children.Remove(c);
          OnChildRemoved?.Invoke(c);
        }
 
        c.parent = null;
 
        CUIDebug.Capture(null, this, "RemoveAllChildren", memberName, "child", $"{c}");
      }
 
      NamedComponents.Clear();
      Children.Clear();
    }

RemoveChild()

CUIComponent CrabUI.CUIComponent.RemoveChild	(	CUIComponent	child,
		[CallerMemberName] string	memberName = "" )

Definition at line 135 of file CUIComponent.Tree.cs.

    {
      if (child == null || !Children.Contains(child)) return child;
 
      if (this != null) // kek
      {
        child.TreeChanged = true;
        child.OnPropChanged();
        //HACK i'm sure it doesn't belong here, find a better place
        forsedSize = new CUINullVector2();
        OnAbsolutePropChanged();
        // Forget(child);
        Children.Remove(child);
        OnChildRemoved?.Invoke(child);
      }
 
      child.parent = null;
 
      CUIDebug.Capture(null, this, "RemoveChild", memberName, "child", $"{child}");
 
      return child;
    }

RunRecursiveOn()

static void CrabUI.CUIComponent.RunRecursiveOn ( CUIComponent component, Action< CUIComponent > action )

static

designed to be versatile, in fact never used

Definition at line 74 of file CUIComponent.cs.

    {
      action(component);
      foreach (CUIComponent child in component.Children)
      {
        RunRecursiveOn(child, action);
      }
    }

SaveToFile()

void CrabUI.CUIComponent.SaveToFile	(	string	path,
		CUIAttribute	propAttribute = CUIAttribute::CUISerializable )

Definition at line 429 of file CUIComponent.Serialization.cs.

    {
      try
      {
        XDocument xdoc = new XDocument();
        xdoc.Add(this.ToXML(propAttribute));
        xdoc.Save(path);
        SavePath = path;
      }
      catch (Exception e)
      {
        CUI.Warning(e);
      }
    }

SaveToTheSamePath()

void CrabUI.CUIComponent.SaveToTheSamePath

(

)

Definition at line 419 of file CUIComponent.Serialization.cs.

    {
      if (SavePath == null)
      {
        CUI.Warning($"Can't save {this} To The Same Path, SavePath is null");
        return;
      }
      SaveToFile(SavePath);
    }

Serialize()

string CrabUI.CUIComponent.Serialize

(

CUIAttribute

propAttribute = CUIAttribute::CUISerializable

)

Definition at line 299 of file CUIComponent.Serialization.cs.

    {
      try
      {
        XElement e = this.ToXML(propAttribute);
        return e.ToString();
      }
      catch (Exception e)
      {
        CUI.Error(e);
        return e.Message;
      }
    }

ShouldInvoke()

virtual bool CrabUI.CUIComponent.ShouldInvoke ( CUIInput e )

virtual

Definition at line 106 of file CUIComponent.Events.cs.

    {
      if (IgnoreTransparent)
      {
        return !IsPointOnTransparentPixel(e.MousePosition);
      }
 
      return true;
    }

ToXML()

virtual XElement CrabUI.CUIComponent.ToXML ( CUIAttribute propAttribute = CUIAttribute::CUISerializable )

virtual

Definition at line 140 of file CUIComponent.Serialization.cs.

    {
      try
      {
        if (!Serializable) return null;
 
        Type type = GetType();
 
        XElement e = new XElement(type.Name);
 
        PackProps(e, propAttribute);
 
        foreach (CUIComponent child in Children)
        {
          if (this.SerializeChildren)
          {
            e.Add(child.ToXML(propAttribute));
          }
        }
 
        return e;
      }
      catch (Exception e)
      {
        CUI.Warning(e);
        return new XElement("Error", e.Message);
      }
    }

Member Data Documentation

Animations

Indexer<string, CUIAnimation> CrabUI.CUIComponent.Animations

Definition at line 30 of file CUIComponent.Animations.cs.

ComponentsById

Dictionary<int, WeakReference<CUIComponent> > CrabUI.CUIComponent.ComponentsById = new()

static

Definition at line 52 of file CUIComponent.cs.

ComponentsByType

WeakCatalog<Type, CUIComponent> CrabUI.CUIComponent.ComponentsByType = new()

static

Definition at line 61 of file CUIComponent.cs.

DataTargets

Dictionary<string, List<CUIComponent> > CrabUI.CUIComponent.DataTargets = new()

Consumers of emmited data, updates on tree change.

Definition at line 138 of file CUIComponent.Commands.cs.

disabled

bool CrabUI.CUIComponent.disabled

protected

Definition at line 26 of file Other Props.cs.

Disposed

bool CrabUI.CUIComponent.Disposed

Definition at line 237 of file CUIComponent.cs.

dummyComponent

GUIButton CrabUI.CUIComponent.dummyComponent

static

Initial value:

= new GUIButton(new RectTransform(new Point(0, 0)))
    {
      Text = "DUMMY",
    }

This is used to trick vanilla GUI into believing that mouse is hovering some component and block clicks.

Definition at line 67 of file CUIComponent.cs.

    {
      Text = "DUMMY",
    };

forsedSize

CUINullVector2 CrabUI.CUIComponent.forsedSize

protected

Definition at line 85 of file CUIComponent.State.cs.

ignoreDebug

bool CrabUI.CUIComponent.ignoreDebug

For debug frame itself.

Definition at line 39 of file CUIComponent.Debug.cs.

layout

CUILayout CrabUI.CUIComponent.layout

protected

Definition at line 23 of file CUIComponent.Layout.cs.

LeftResizeHandle

CUIResizeHandle CrabUI.CUIComponent.LeftResizeHandle = new CUIResizeHandle(new Vector2(0, 1), new CUIBool2(false, false))

Definition at line 153 of file CUIComponent.Events.cs.

RightResizeHandle

CUIResizeHandle CrabUI.CUIComponent.RightResizeHandle = new CUIResizeHandle(new Vector2(1, 1), new CUIBool2(true, false))

Definition at line 154 of file CUIComponent.Events.cs.

scale

float CrabUI.CUIComponent.scale = 1f

protected

Definition at line 103 of file CUIComponent.State.cs.

TextureData

Color [] CrabUI.CUIComponent.TextureData

protected

Buffer for texture data, for IgnoreTransparent checks.

Definition at line 119 of file CUIComponent.State.cs.

Property Documentation

Absolute

CUINullRect CrabUI.CUIComponent.Absolute

getset

Absolute size and position in pixels.

Implements CrabUI.ISimpleProps.

Definition at line 123 of file Layout Props.cs.

    {
      get => CUIProps.Absolute.Value;
      set => CUIProps.Absolute.SetValue(value);
    }

AbsoluteMax

CUINullRect CrabUI.CUIComponent.AbsoluteMax

getset

Implements CrabUI.ISimpleProps.

Definition at line 135 of file Layout Props.cs.

    {
      get => CUIProps.AbsoluteMax.Value;
      set => CUIProps.AbsoluteMax.SetValue(value);
    }

AbsoluteMin

CUINullRect CrabUI.CUIComponent.AbsoluteMin

getset

Implements CrabUI.ISimpleProps.

Definition at line 129 of file Layout Props.cs.

    {
      get => CUIProps.AbsoluteMin.Value;
      set => CUIProps.AbsoluteMin.SetValue(value);
    }

AddChildren

IEnumerable<CUIComponent> CrabUI.CUIComponent.AddChildren

set

Allows you to add array of children.

Definition at line 80 of file CUIComponent.Tree.cs.

{ set { foreach (CUIComponent c in value) { Append(c); } } }

AddOnClick

Action<CUIInput> CrabUI.CUIComponent.AddOnClick

set

Definition at line 64 of file CUIComponent.Events.cs.

{ set { OnClick += value; } }

AddOnDClick

Action<CUIInput> CrabUI.CUIComponent.AddOnDClick

set

Definition at line 65 of file CUIComponent.Events.cs.

{ set { OnDClick += value; } }

AddOnDrag

Action<float, float> CrabUI.CUIComponent.AddOnDrag

set

Definition at line 67 of file CUIComponent.Events.cs.

{ set { OnDrag += value; } }

AddOnFocus

Action CrabUI.CUIComponent.AddOnFocus

set

Definition at line 72 of file CUIComponent.Events.cs.

{ set { OnFocus += value; } }

AddOnFocusLost

Action CrabUI.CUIComponent.AddOnFocusLost

set

Definition at line 73 of file CUIComponent.Events.cs.

{ set { OnFocusLost += value; } }

AddOnKeyDown

Action<CUIInput> CrabUI.CUIComponent.AddOnKeyDown

set

Definition at line 69 of file CUIComponent.Events.cs.

{ set { OnKeyDown += value; } }

AddOnKeyUp

Action<CUIInput> CrabUI.CUIComponent.AddOnKeyUp

set

Definition at line 70 of file CUIComponent.Events.cs.

{ set { OnKeyUp += value; } }

AddOnMouseDown

Action<CUIInput> CrabUI.CUIComponent.AddOnMouseDown

set

Definition at line 59 of file CUIComponent.Events.cs.

{ set { OnMouseDown += value; } }

AddOnMouseEnter

Action<CUIInput> CrabUI.CUIComponent.AddOnMouseEnter

set

Definition at line 58 of file CUIComponent.Events.cs.

{ set { OnMouseEnter += value; } }

AddOnMouseLeave

Action<CUIInput> CrabUI.CUIComponent.AddOnMouseLeave

set

Definition at line 57 of file CUIComponent.Events.cs.

{ set { OnMouseLeave += value; } }

AddOnMouseMove

Action<CUIInput> CrabUI.CUIComponent.AddOnMouseMove

set

Definition at line 61 of file CUIComponent.Events.cs.

{ set { OnMouseMove += value; } }

AddOnMouseOff

Action<CUIInput> CrabUI.CUIComponent.AddOnMouseOff

set

Definition at line 63 of file CUIComponent.Events.cs.

{ set { OnMouseOff += value; } }

AddOnMouseOn

Action<CUIInput> CrabUI.CUIComponent.AddOnMouseOn

set

Definition at line 62 of file CUIComponent.Events.cs.

{ set { OnMouseOn += value; } }

AddOnMouseUp

Action<CUIInput> CrabUI.CUIComponent.AddOnMouseUp

set

Definition at line 60 of file CUIComponent.Events.cs.

{ set { OnMouseUp += value; } }

AddOnScroll

Action<CUIInput> CrabUI.CUIComponent.AddOnScroll

set

Definition at line 66 of file CUIComponent.Events.cs.

{ set { OnScroll += value; } }

AddOnSwipe

Action<float, float> CrabUI.CUIComponent.AddOnSwipe

set

Definition at line 68 of file CUIComponent.Events.cs.

{ set { OnSwipe += value; } }

AddOnTextInput

Action<CUIInput> CrabUI.CUIComponent.AddOnTextInput

set

Definition at line 71 of file CUIComponent.Events.cs.

{ set { OnTextInput += value; } }

AddOnUpdate

Action<double> CrabUI.CUIComponent.AddOnUpdate

set

Definition at line 56 of file CUIComponent.Events.cs.

{ set { OnUpdate += value; } }

AKA

string CrabUI.CUIComponent.AKA

getset

Parent can memorize it's children by their names, AKA.

Definition at line 78 of file CUIComponent.Debug.cs.

{ get; set; }

AllComponents

IEnumerable<CUIComponent> CrabUI.CUIComponent.AllComponents

staticget

Definition at line 53 of file CUIComponent.cs.

Anchor

Vector2 CrabUI.CUIComponent.Anchor

getset

this point of this component

Definition at line 63 of file Layout Props.cs.

{ get; set; }

AttachedItemHandle

AttachedItemHandle CrabUI.CUIComponent.AttachedItemHandle

getset

Definition at line 23 of file CUIComponent.Attached Item.cs.

{ get; set; }

BackgroundColor

Color CrabUI.CUIComponent.BackgroundColor

getset

Color of BackgroundSprite, default is black
If you're using custom sprite and don't see it make sure this color is not black.

Definition at line 89 of file Graphic Props.cs.

    {
      get => CUIProps.BackgroundColor.Value;
      set => CUIProps.BackgroundColor.SetValue(value);
    }

BackgroundSprite

CUISprite CrabUI.CUIComponent.BackgroundSprite

getset

Will be drawn in background with BackgroundColor
Default is solid white 1x1 texture.

Definition at line 66 of file Graphic Props.cs.

    {
      get => CUIProps.BackgroundSprite.Value;
      set => CUIProps.BackgroundSprite.SetValue(value);
    }

BackgroundVisible

bool CrabUI.CUIComponent.BackgroundVisible

getsetprotected

BackgroundColor != Color.Transparent.

Definition at line 56 of file CUIComponent.State.cs.

{ get; set; }

Border

CUIBorder CrabUI.CUIComponent.Border = new CUIBorder()

getset

Container for Color and Thickness
Border is drawn inside the component and will eat space from content
If "by side" border prop != null then it'll take presidence.

Definition at line 43 of file Graphic Props.cs.

{ get; set; } = new CUIBorder();

BorderBox

CUIRect CrabUI.CUIComponent.BorderBox

getsetprotected

Calculated Prop, Real + BorderThickness.

Definition at line 113 of file CUIComponent.State.cs.

{ get; set; }

BorderSprite

CUISprite CrabUI.CUIComponent.BorderSprite = CUISprite.Default

getset

Should be one texture, not sprite sheet
Or there would be no way to wrap it
Top side will always point outwards.

Definition at line 36 of file Graphic Props.cs.

{ get; set; } = CUISprite.Default;

BottomBorder

CUIBorder CrabUI.CUIComponent.BottomBorder

getset

Definition at line 46 of file Graphic Props.cs.

{ get; set; }

Children

List<CUIComponent> CrabUI.CUIComponent.Children = new()

getset

Definition at line 23 of file CUIComponent.Tree.cs.

{ get; set; } = new();

ChildrenBoundaries

Func<CUIRect, CUIBoundaries> CrabUI.CUIComponent.ChildrenBoundaries

getset

Limits to children positions.

Definition at line 54 of file Layout Props.cs.

{ get; set; }

ChildrenOffset

CUI3DOffset CrabUI.CUIComponent.ChildrenOffset

getset

Will shift all children by this much, e.g. this is how scroll works It's also 3D.

Definition at line 45 of file Layout Props.cs.

    {
      get => CUIProps.ChildrenOffset.Value;
      set => CUIProps.ChildrenOffset.SetValue(value);
    }

Command

string CrabUI.CUIComponent.Command

getset

This command will be dispatched up when some component specific event happens.

Definition at line 49 of file CUIComponent.Commands.cs.

{ get; set; }

Commands

Dictionary<string, Action<object> > CrabUI.CUIComponent.Commands = new()

getset

All commands.

Definition at line 144 of file CUIComponent.Commands.cs.

{ get; set; } = new();

ConsumeDragAndDrop

bool CrabUI.CUIComponent.ConsumeDragAndDrop

getset

Definition at line 24 of file CUIComponent.Events.cs.

{ get; set; }

ConsumeMouseClicks

bool CrabUI.CUIComponent.ConsumeMouseClicks

getset

Definition at line 23 of file CUIComponent.Events.cs.

{ get; set; }

ConsumeMouseScroll

bool CrabUI.CUIComponent.ConsumeMouseScroll

getset

Definition at line 26 of file CUIComponent.Events.cs.

{ get; set; }

Consumes

string CrabUI.CUIComponent.Consumes

getset

Will consume data with this name.

Definition at line 65 of file CUIComponent.Commands.cs.

{ get; set; }

ConsumeSwipe

bool CrabUI.CUIComponent.ConsumeSwipe

getset

Definition at line 25 of file CUIComponent.Events.cs.

{ get; set; }

CrossRelative

CUINullRect CrabUI.CUIComponent.CrossRelative

getset

It's like Relative, but to the opposite dimension
E.g. Real.Width = CrossRelative.Width * Parent.Real.Height
Handy for creating square things.

Implements CrabUI.ISimpleProps.

Definition at line 167 of file Layout Props.cs.

    {
      get => CUIProps.CrossRelative.Value;
      set => CUIProps.CrossRelative.SetValue(value);
    }

CUIProps

CUIComponentProps CrabUI.CUIComponent.CUIProps = new()

getset

Just a wrapper for CUIProps idk how to separate them better.

Definition at line 27 of file CUIProps.cs.

{ get; set; } = new();

CullChildren

bool CrabUI.CUIComponent.CullChildren

getset

if child rect doesn't intersect with parent it won't be drawn and won't consume fps
It also sets HideChildrenOutsideFrame

Definition at line 30 of file Layout Props.cs.

    {
      get => CUIProps.CullChildren.Value;
      set => CUIProps.CullChildren.SetValue(value);
    }

Data

object CrabUI.CUIComponent.Data

getset

Arbitrary data.

Definition at line 25 of file Other Props.cs.

{ get; set; }

Debug

bool CrabUI.CUIComponent.Debug

getset

Definition at line 26 of file CUIComponent.Debug.cs.

    {
      get => debug;
      set
      {
        debug = value;
        //foreach (CUIComponent c in Children) { c.Debug = value; }
      }
    }

DeepPalette

PaletteOrder CrabUI.CUIComponent.DeepPalette

set

Definition at line 118 of file Graphic Props.cs.

    {
      set
      {
        Palette = value;
        foreach (var child in Children)
        {
          child.DeepPalette = value;
        }
      }
    }

Disabled

virtual bool CrabUI.CUIComponent.Disabled

getset

Usually means - non interactable, e.g. unclickable gray button.

Definition at line 31 of file Other Props.cs.

    {
      get => disabled;
      set => disabled = value;
    }

Draggable

bool CrabUI.CUIComponent.Draggable

getset

Definition at line 140 of file CUIComponent.Events.cs.

    {
      get => DragHandle.Draggable;
      set => DragHandle.Draggable = value;
    }

Emits

ObservableCollection<string> CrabUI.CUIComponent.Emits

getset

Optimization to data flow
If not empty component will search for consumers of the data and pass it directly to them instead of broadcasting it.

Definition at line 106 of file CUIComponent.Commands.cs.

    {
      get => emits;
      set
      {
        emits = value;
        emits.CollectionChanged += (o, e) => UpdateDataTargets();
        UpdateDataTargets();
      }
    }

FillEmptySpace

CUIBool2 CrabUI.CUIComponent.FillEmptySpace

getset

Will be resized to fill empty space in list components.

Implements CrabUI.IListProps.

Definition at line 105 of file Layout Props.cs.

    {
      get => CUIProps.FillEmptySpace.Value;
      set => CUIProps.FillEmptySpace.SetValue(value);
    }

FitContent

CUIBool2 CrabUI.CUIComponent.FitContent

getset

Will resize itself to fit components with absolute size, e.g. text.

Implements CrabUI.ISimpleProps.

Definition at line 114 of file Layout Props.cs.

    {
      get => CUIProps.FitContent.Value;
      set => CUIProps.FitContent.SetValue(value);
    }

Fixed

bool CrabUI.CUIComponent.Fixed

getset

Should it ignore child offset?

Definition at line 59 of file Layout Props.cs.

{ get; set; }

Focusable

bool CrabUI.CUIComponent.Focusable

getset

Definition at line 148 of file CUIComponent.Events.cs.

    {
      get => FocusHandle.Focusable;
      set => FocusHandle.Focusable = value;
    }

Focused

bool CrabUI.CUIComponent.Focused

getset

Definition at line 46 of file CUIComponent.State.cs.

{ get; set; }

ForcedMinSize

CUINullVector2 CrabUI.CUIComponent.ForcedMinSize

getset

This is used by text to prevent resizing beyond that and works as AbsoluteMin.

Definition at line 80 of file CUIComponent.State.cs.

    {
      get => forsedSize;
      set => SetForcedMinSize(value);
    }

ForceSaveAllProps

bool CrabUI.CUIComponent.ForceSaveAllProps = false

staticgetset

Implements CrabUI.ISerializationProps.

Definition at line 41 of file Serialization Props.cs.

{ get; set; } = false;

Ghost

CUIBool2 CrabUI.CUIComponent.Ghost

getset

Ghost components don't affect layout.

Implements CrabUI.ISimpleProps.

Definition at line 73 of file Layout Props.cs.

    {
      get => CUIProps.Ghost.Value;
      set => CUIProps.Ghost.SetValue(value);
    }

GridCell

Point? CrabUI.CUIComponent.GridCell

getset

Sets both GridStartCell and GridEndCell at once.

Definition at line 192 of file Layout Props.cs.

    {
      get => GridStartCell;
      set
      {
        GridStartCell = value;
        GridEndCell = value;
      }
    }

GridEndCell

Point? CrabUI.CUIComponent.GridEndCell

getset

And resized to fit cells from GridStartCell to GridEndCell.

Definition at line 188 of file Layout Props.cs.

{ get; set; }

GridStartCell

Point? CrabUI.CUIComponent.GridStartCell

getset

Component will be placed in this cell in the grid component.

Definition at line 184 of file Layout Props.cs.

{ get; set; }

GridTemplateColumns

string CrabUI.CUIComponent.GridTemplateColumns

getset

Used in Grid, space separated Columns sizes, either in pixels (123) or in % (123%)

Definition at line 180 of file Layout Props.cs.

{ get; set; }

GridTemplateRows

string CrabUI.CUIComponent.GridTemplateRows

getset

Used in Grid, space separated Row sizes, either in pixels (123) or in % (123%)

Definition at line 176 of file Layout Props.cs.

{ get; set; }

HideChildrenOutsideFrame

bool CrabUI.CUIComponent.HideChildrenOutsideFrame

getset

Should children be cut off by scissor rect, this is just visual, it's not the same as culling.

Definition at line 24 of file Layout Props.cs.

{ get; set; }

ID

int CrabUI.CUIComponent.ID

getset

Global ID, unique for component.

Definition at line 25 of file CUIComponent.State.cs.

{ get; set; }

IgnoreDebug

bool CrabUI.CUIComponent.IgnoreDebug

getset

Definition at line 39 of file CUIComponent.Debug.cs.

    {
      get => ignoreDebug || Unreal;
      set
      {
        ignoreDebug = value;
        foreach (CUIComponent c in Children) { c.IgnoreDebug = value; }
      }
    }

IgnoreEvents

bool CrabUI.CUIComponent.IgnoreEvents

getset

Won't react to mouse events.

Definition at line 68 of file Other Props.cs.

    {
      get => CUIProps.IgnoreEvents.Value;
      set => CUIProps.IgnoreEvents.SetValue(value);
    }

IgnoreParentEventIgnorance

bool CrabUI.CUIComponent.IgnoreParentEventIgnorance

getset

Don't inherit parent IgnoreEvents.

Definition at line 48 of file Other Props.cs.

{ get; set; }

IgnoreParentTransparency

bool CrabUI.CUIComponent.IgnoreParentTransparency

getset

Definition at line 53 of file Other Props.cs.

{ get; set; }

IgnoreParentVisibility

bool CrabUI.CUIComponent.IgnoreParentVisibility

getset

Don't inherit parent Visibility.

Definition at line 44 of file Other Props.cs.

{ get; set; }

IgnoreParentZIndex

bool CrabUI.CUIComponent.IgnoreParentZIndex

getset

Don't inherit parent ZIndex.

Definition at line 52 of file Other Props.cs.

{ get; set; }

IgnoreTransparent

bool CrabUI.CUIComponent.IgnoreTransparent

getset

If true, mouse events on transparent pixels will be ignored
Note: this will buffer texture data and potentially consume a lot of memory so use wisely.

Definition at line 77 of file Graphic Props.cs.

    {
      get => CUIProps.IgnoreTransparent.Value;
      set => CUIProps.IgnoreTransparent.SetValue(value);
    }

Layout

virtual CUILayout CrabUI.CUIComponent.Layout

getset

Definition at line 25 of file CUIComponent.Layout.cs.

    {
      get => layout;
      set { layout = value; layout.Host = this; }
    }

LeftBorder

CUIBorder CrabUI.CUIComponent.LeftBorder

getset

Definition at line 47 of file Graphic Props.cs.

{ get; set; }

MainComponent

CUIMainComponent CrabUI.CUIComponent.MainComponent

getset

Link to CUIMainComponent, passed to children.

Definition at line 33 of file CUIComponent.State.cs.

    {
      get => mainComponent;
      set
      {
        mainComponent = value;
        foreach (var child in Children) { child.MainComponent = value; }
      }
    }

MergeSerialization

bool CrabUI.CUIComponent.MergeSerialization = false

getset

If true it won't be deserialized,
Instead its children will be detached and attached to the component with matching AKA on the parent.

Implements CrabUI.ISerializationProps.

Definition at line 35 of file Serialization Props.cs.

{ get; set; } = false;

MouseOver

bool CrabUI.CUIComponent.MouseOver

getset

Definition at line 72 of file CUIComponent.State.cs.

{ get; set; }

MousePressed

bool CrabUI.CUIComponent.MousePressed

getset

Definition at line 73 of file CUIComponent.State.cs.

{ get; set; }

NamedComponents

Dictionary<string, CUIComponent> CrabUI.CUIComponent.NamedComponents = new()

getset

All memorized components.

Definition at line 82 of file CUIComponent.Debug.cs.

{ get; set; } = new();

OutlineBox

CUIRect CrabUI.CUIComponent.OutlineBox

getsetprotected

Definition at line 114 of file CUIComponent.State.cs.

{ get; set; }

OutlineColor

Color CrabUI.CUIComponent.OutlineColor

getset

Outline is like a border, but on the outside of the component.

Definition at line 56 of file Graphic Props.cs.

    {
      get => CUIProps.OutlineColor.Value;
      set => CUIProps.OutlineColor.SetValue(value);
    }

OutlineThickness

float CrabUI.CUIComponent.OutlineThickness = 1f

getset

Definition at line 51 of file Graphic Props.cs.

{ get; set; } = 1f;

OutlineVisible

bool CrabUI.CUIComponent.OutlineVisible

getsetprotected

Definition at line 58 of file CUIComponent.State.cs.

{ get; set; }

Padding

Vector2 CrabUI.CUIComponent.Padding

getsetadd

Used for text, should be in CUITextBlock really.

Definition at line 25 of file Graphic Props.cs.

    {
      get => CUIProps.Padding.Value;
      set => CUIProps.Padding.SetValue(value);
    }

Palette

PaletteOrder CrabUI.CUIComponent.Palette

getset

This palette will be used to resolve palette styles
Primary, Secondary, Tertiary, Quaternary.

Definition at line 113 of file Graphic Props.cs.

    {
      get => CUIProps.Palette.Value;
      set => CUIProps.Palette.SetValue(value);
    }

Parent

CUIComponent? CrabUI.CUIComponent.Parent

getset

Definition at line 25 of file CUIComponent.Tree.cs.

    {
      get => parent;
      set => SetParent(value);
    }

ParentAnchor

Vector2? CrabUI.CUIComponent.ParentAnchor

getset

will be attached to this point of parent

Definition at line 67 of file Layout Props.cs.

{ get; set; }

Real

CUIRect CrabUI.CUIComponent.Real

getset

Calculated prop, position on real screen in pixels Should be fully calculated after CUIMainComponent.Update.

Definition at line 125 of file CUIComponent.State.cs.

    {
      get => real;
      set => SetReal(value);
    }

ReflectCommands

bool CrabUI.CUIComponent.ReflectCommands

getset

Definition at line 69 of file CUIComponent.Commands.cs.

    {
      get => reflectCommands;
      set
      {
        reflectCommands = value;
        OnAnyCommand += (command) =>
        {
          foreach (CUIComponent child in Children)
          {
            child.DispatchDown(new CUIData(command.Name, command.Data));
          }
        };
      }
    }

Relative

CUINullRect CrabUI.CUIComponent.Relative

getset

Relative to parent size and position, [0..1].

Implements CrabUI.ISimpleProps.

Definition at line 144 of file Layout Props.cs.

    {
      get => CUIProps.Relative.Value;
      set => CUIProps.Relative.SetValue(value);
    }

RelativeMax

CUINullRect CrabUI.CUIComponent.RelativeMax

getset

Implements CrabUI.ISimpleProps.

Definition at line 156 of file Layout Props.cs.

    {
      get => CUIProps.RelativeMax.Value;
      set => CUIProps.RelativeMax.SetValue(value);
    }

RelativeMin

CUINullRect CrabUI.CUIComponent.RelativeMin

getset

Implements CrabUI.ISimpleProps.

Definition at line 150 of file Layout Props.cs.

    {
      get => CUIProps.RelativeMin.Value;
      set => CUIProps.RelativeMin.SetValue(value);
    }

ReplaceSerialization

bool CrabUI.CUIComponent.ReplaceSerialization = false

getset

If true, deserialized component will replace existing component with the same AKA instead of creating a duplicate.

Implements CrabUI.ISerializationProps.

Definition at line 40 of file Serialization Props.cs.

{ get; set; } = false;

ResizeDirection

CUIBool2 CrabUI.CUIComponent.ResizeDirection

getset

Definition at line 176 of file CUIComponent.Events.cs.

    {
      get => RightResizeHandle.Direction;
      set
      {
        LeftResizeHandle.Direction = value;
        RightResizeHandle.Direction = value;
      }
    }

ResizeHandleColor

Color CrabUI.CUIComponent.ResizeHandleColor = Color.White

getset

Had to expose resize handle props, because it's not a real component and can't really use styles.

Definition at line 134 of file Graphic Props.cs.

{ get; set; } = Color.White;

ResizeHandleGrabbedColor

Color CrabUI.CUIComponent.ResizeHandleGrabbedColor = Color.Cyan

getset

Definition at line 136 of file Graphic Props.cs.

{ get; set; } = Color.Cyan;

ResizeToSprite

bool CrabUI.CUIComponent.ResizeToSprite

getset

If true component will set it's Absolute size to sprite texture size.

Definition at line 95 of file Layout Props.cs.

    {
      get => CUIProps.ResizeToSprite.Value;
      set => CUIProps.ResizeToSprite.SetValue(value);
    }

Resizible

bool CrabUI.CUIComponent.Resizible

getset

Definition at line 155 of file CUIComponent.Events.cs.

    {
      get => ResizibleLeft || ResizibleRight;
      set { ResizibleLeft = value; ResizibleRight = value; }
    }

ResizibleLeft

bool CrabUI.CUIComponent.ResizibleLeft

getset

Definition at line 162 of file CUIComponent.Events.cs.

    {
      get => LeftResizeHandle.Visible;
      set => LeftResizeHandle.Visible = value;
    }

ResizibleRight

bool CrabUI.CUIComponent.ResizibleRight

getset

Definition at line 169 of file CUIComponent.Events.cs.

    {
      get => RightResizeHandle.Visible;
      set => RightResizeHandle.Visible = value;
    }

ResolvedStyle

CUIStyle CrabUI.CUIComponent.ResolvedStyle

getset

Definition at line 75 of file CUIComponent.Style.cs.

{ get; set; }

RetranslateCommands

bool CrabUI.CUIComponent.RetranslateCommands

getset

Definition at line 87 of file CUIComponent.Commands.cs.

    {
      get => retranslateCommands;
      set
      {
        retranslateCommands = value;
        OnAnyCommand += (command) =>
        {
          Parent?.DispatchUp(command);
        };
      }
    }

Revealed

bool CrabUI.CUIComponent.Revealed

getset

Visible + !IgnoreEvents.

Definition at line 77 of file Other Props.cs.

    {
      get => CUIProps.Revealed.Value;
      set => CUIProps.Revealed.SetValue(value);
    }

RigthBorder

CUIBorder CrabUI.CUIComponent.RigthBorder

getset

Definition at line 45 of file Graphic Props.cs.

{ get; set; }

SamplerState

SamplerState CrabUI.CUIComponent.SamplerState

getset

don't

Definition at line 141 of file Graphic Props.cs.

{ get; set; }

SavePath

string CrabUI.CUIComponent.SavePath

getset

Definition at line 138 of file CUIComponent.Serialization.cs.

{ get; set; }

Scale

float CrabUI.CUIComponent.Scale

getset

This is set by ChildrenOffset when zooming, and iirc consumed by text to adjust text scale.

Definition at line 98 of file CUIComponent.State.cs.

    {
      get => scale;
      set => SetScale(value);
    }

Serializable

bool CrabUI.CUIComponent.Serializable = true

getset

If false then this component and its children won't be serialized.

Implements CrabUI.ISerializationProps.

Definition at line 24 of file Serialization Props.cs.

{ get; set; } = true;

SerializeChildren

bool CrabUI.CUIComponent.SerializeChildren = true

getset

Is this a serialization cutoff point
Parent will serialize children down to this component and stop.

Implements CrabUI.ISerializationProps.

Definition at line 29 of file Serialization Props.cs.

{ get; set; } = true;

ShouldPassPropsToChildren

bool CrabUI.CUIComponent.ShouldPassPropsToChildren = true

getset

Some props (like visible) are autopassed to all new childs see PassPropsToChild.

Definition at line 40 of file Other Props.cs.

{ get; set; } = true;

States

Dictionary<string, CUIComponent> CrabUI.CUIComponent.States = new()

getset

State is just a clone component with copies of all props.

Definition at line 68 of file CUIComponent.Serialization.cs.

{ get; set; } = new();

Style

CUIStyle CrabUI.CUIComponent.Style

getset

Allows you to assing parsable string or link to CUIPalette to any prop
It's indexable, so you can access it like this: component.Style["BackgroundColor"] = "cyan"
if value starts with "CUIPalette." it will extract the value from palette
e.g. component.Style["BackgroundColor"] = "CUIPalette.DarkBlue.Secondary.On"

Definition at line 50 of file CUIComponent.Style.cs.

    {
      get => style;
      set
      {
        if (style == value) return;
 
        if (style != null)
        {
          style.OnUse -= HandleStyleChange;
          style.OnPropChanged -= HandleStylePropChange;
        }
 
        style = value;
 
        if (style != null)
        {
          style.OnUse += HandleStyleChange;
          style.OnPropChanged += HandleStylePropChange;
        }
 
        HandleStyleChange(style);
      }
    }

Swipeable

bool CrabUI.CUIComponent.Swipeable

getset

Definition at line 188 of file CUIComponent.Events.cs.

    {
      get => SwipeHandle.Swipeable;
      set => SwipeHandle.Swipeable = value;
    }

this[string name]

CUIComponent CrabUI.CUIComponent.this[string name]

getset

You can access NamedComponents with this indexer.

Parameters

name

Returns

Definition at line 120 of file CUIComponent.Debug.cs.

    {
      get => Get(name);
      set
      {
        if (value.Parent != null) Remember(value, name);
        else Append(value, name);
      }
    }

TopBorder

CUIBorder CrabUI.CUIComponent.TopBorder

getset

Definition at line 44 of file Graphic Props.cs.

{ get; set; }

Transparency

float CrabUI.CUIComponent.Transparency

getset

Definition at line 96 of file Graphic Props.cs.

    {
      get => transparency;
      set
      {
        transparency = value;
        foreach (CUIComponent child in Children)
        {
          if (!child.IgnoreParentTransparency) child.Transparency = value;
        }
      }
    }

UnCullable

bool CrabUI.CUIComponent.UnCullable

getset

It shouldn't be culled off even outside of parent bounds and even if parent demands so.

Definition at line 39 of file Layout Props.cs.

{ get; set; }

Visible

bool CrabUI.CUIComponent.Visible

getset

Invisible components are not drawn, but still can be interacted with.

Definition at line 59 of file Other Props.cs.

    {
      get => CUIProps.Visible.Value;
      set => CUIProps.Visible.SetValue(value);
    }

ZIndex

int? CrabUI.CUIComponent.ZIndex

getset

Components are drawn in order of their ZIndex
Normally it's derived from component position in the tree, but this will override it.

Definition at line 84 of file Layout Props.cs.

    {
      get => CUIProps.ZIndex.Value;
      set => CUIProps.ZIndex.SetValue(value);
    }

Event Documentation

OnAnyCommand

Action<CUICommand> CrabUI.CUIComponent.OnAnyCommand

this will be executed on any command

Definition at line 53 of file CUIComponent.Commands.cs.

OnAnyData

Action<CUIData> CrabUI.CUIComponent.OnAnyData

Will be executed when receiving any data.

Definition at line 57 of file CUIComponent.Commands.cs.

OnChildAdded

Action<CUIComponent> CrabUI.CUIComponent.OnChildAdded

Definition at line 82 of file CUIComponent.Tree.cs.

OnChildRemoved

Action<CUIComponent> CrabUI.CUIComponent.OnChildRemoved

Definition at line 83 of file CUIComponent.Tree.cs.

OnClick

Action<CUIInput> CrabUI.CUIComponent.OnClick

Definition at line 44 of file CUIComponent.Events.cs.

OnConsume

Action<Object> CrabUI.CUIComponent.OnConsume

Happens when appropriate data is received.

Definition at line 61 of file CUIComponent.Commands.cs.

OnDClick

Action<CUIInput> CrabUI.CUIComponent.OnDClick

Definition at line 45 of file CUIComponent.Events.cs.

OnDrag

Action<float, float> CrabUI.CUIComponent.OnDrag

Definition at line 47 of file CUIComponent.Events.cs.

OnFocus

Action CrabUI.CUIComponent.OnFocus

Definition at line 52 of file CUIComponent.Events.cs.

OnFocusLost

Action CrabUI.CUIComponent.OnFocusLost

Definition at line 53 of file CUIComponent.Events.cs.

OnKeyDown

Action<CUIInput> CrabUI.CUIComponent.OnKeyDown

Definition at line 49 of file CUIComponent.Events.cs.

OnKeyUp

Action<CUIInput> CrabUI.CUIComponent.OnKeyUp

Definition at line 50 of file CUIComponent.Events.cs.

OnLayoutUpdated

Action CrabUI.CUIComponent.OnLayoutUpdated

Definition at line 31 of file CUIComponent.Layout.cs.

OnMouseDown

Action<CUIInput> CrabUI.CUIComponent.OnMouseDown

Definition at line 39 of file CUIComponent.Events.cs.

OnMouseEnter

Action<CUIInput> CrabUI.CUIComponent.OnMouseEnter

Definition at line 38 of file CUIComponent.Events.cs.

OnMouseLeave

Action<CUIInput> CrabUI.CUIComponent.OnMouseLeave

Definition at line 37 of file CUIComponent.Events.cs.

OnMouseMove

Action<CUIInput> CrabUI.CUIComponent.OnMouseMove

Definition at line 41 of file CUIComponent.Events.cs.

OnMouseOff

Action<CUIInput> CrabUI.CUIComponent.OnMouseOff

Definition at line 43 of file CUIComponent.Events.cs.

OnMouseOn

Action<CUIInput> CrabUI.CUIComponent.OnMouseOn

Definition at line 42 of file CUIComponent.Events.cs.

OnMouseUp

Action<CUIInput> CrabUI.CUIComponent.OnMouseUp

Definition at line 40 of file CUIComponent.Events.cs.

OnScroll

Action<CUIInput> CrabUI.CUIComponent.OnScroll

Definition at line 46 of file CUIComponent.Events.cs.

OnStyleApplied

Action CrabUI.CUIComponent.OnStyleApplied

Use it to e.g. update component color.

Definition at line 30 of file CUIComponent.Style.cs.

OnSwipe

Action<float, float> CrabUI.CUIComponent.OnSwipe

Definition at line 48 of file CUIComponent.Events.cs.

OnTextInput

Action<CUIInput> CrabUI.CUIComponent.OnTextInput

Definition at line 51 of file CUIComponent.Events.cs.

OnTreeChanged

Action CrabUI.CUIComponent.OnTreeChanged

Definition at line 35 of file CUIComponent.Events.cs.

OnUpdate

Action<double> CrabUI.CUIComponent.OnUpdate

Definition at line 36 of file CUIComponent.Events.cs.

---

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

• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.Animations.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.Attached Item.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.Commands.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.Debug.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.Events.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.Layout.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.Serialization.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.State.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.Style.cs
• CSharp/Client/CrabUI/Components/CUIComponent/CUIComponent.Tree.cs
• CSharp/Client/CrabUI/Components/CUIComponent/Props/CUIProps.cs
• CSharp/Client/CrabUI/Components/CUIComponent/Props/Graphic Props.cs
• CSharp/Client/CrabUI/Components/CUIComponent/Props/Layout Props.cs
• CSharp/Client/CrabUI/Components/CUIComponent/Props/Other Props.cs
• CSharp/Client/CrabUI/Components/CUIComponent/Props/Serialization Props.cs