TriDevs.TriEngine.UI.ControlManager Class Reference

Control manager to manage various UI controls for a game. More...

Inheritance diagram for TriDevs.TriEngine.UI.ControlManager:

Collaboration diagram for TriDevs.TriEngine.UI.ControlManager:

Public Member Functions
	ControlManager ()
	Initializes a new instance of this control manager. More...
void	Enable ()
	Enables this game component. More...
void	Disable ()
	Disables this game component. More...
void	Update ()
	Updates the object. More...
void	Draw ()
	Draw the object to screen. More...
IControl	AddControl (IControl control)
	Adds a new control to this control manager. More...
void	RemoveControl (IControl control)
	Removes a control from this control manager. More...
void	RemoveAllControls (Type type)
	Removes all controls of a specific type from this control manager. More...
void	RemoveAllControls (Func< IControl, bool > func)
	Removes all controls matching the supplied predicate function. More...
bool	HasControl (IControl control)
	Returns whether this control manager contains the specified control. More...
bool	HasControl (Type type)
	Returns whether this control manager contains any control of the specified type. More...
bool	HasControl (Func< IControl, bool > func)
	Returns whether this control manager contains any control matching the supplied predicate function. More...

Properties
bool	Enabled [get, set]

Detailed Description

Control manager to manage various UI controls for a game.

Constructor & Destructor Documentation

TriDevs.TriEngine.UI.ControlManager.ControlManager

(

)

Initializes a new instance of this control manager.

        {
            _controls = new List<IControl>();
        }

Member Function Documentation

IControl TriDevs.TriEngine.UI.ControlManager.AddControl

(

IControl

control

)

Adds a new control to this control manager.

Parameters

control

The control to add.

Returns

The control that was added.

Implements TriDevs.TriEngine.UI.IControlManager.

        {
            if (HasControl(control))
                throw new InvalidOperationException("Cannot add a control more than once.");
            control.Enable();
            _controls.Add(control);
            control.Show();
            return control;
        }

Here is the call graph for this function:

void TriDevs.TriEngine.UI.ControlManager.Disable

(

)

Disables this game component.

Implements TriDevs.TriEngine.Interfaces.IGameComponent.

        {
            Enabled = false;
        }

void TriDevs.TriEngine.UI.ControlManager.Draw

(

)

Draw the object to screen.

Implements TriDevs.TriEngine.Interfaces.IDrawable.

        {
            _controls.ForEach(c => c.Draw());
        }

void TriDevs.TriEngine.UI.ControlManager.Enable

(

)

Enables this game component.

Implements TriDevs.TriEngine.Interfaces.IGameComponent.

        {
            Enabled = true;
        }

bool TriDevs.TriEngine.UI.ControlManager.HasControl

(

IControl

control

)

Returns whether this control manager contains the specified control.

Parameters

control

The control to check.

Returns

True if the specified control exists in this control manager, false otherwise.

Implements TriDevs.TriEngine.UI.IControlManager.

        {
            return HasControl(c => c == control);
        }

bool TriDevs.TriEngine.UI.ControlManager.HasControl

(

Type

type

)

Returns whether this control manager contains any control of the specified type.

Parameters

type	The type to check.

Returns

True if this control manager contains a control of the specified type, false otherwise.

Implements TriDevs.TriEngine.UI.IControlManager.

        {
            return HasControl(c => c.GetType() == type);
        }

bool TriDevs.TriEngine.UI.ControlManager.HasControl

(

Func< IControl, bool >

func

)

Returns whether this control manager contains any control matching the supplied predicate function.

Parameters

func	The predicate function.

Returns

True if this control manager contains a control matching the specified predicate, false otherwise.

Implements TriDevs.TriEngine.UI.IControlManager.

        {
            return _controls.Any(func);
        }

void TriDevs.TriEngine.UI.ControlManager.RemoveAllControls

(

Type

type

)

Removes all controls of a specific type from this control manager.

Parameters

type	The type of control to remove.

Implements TriDevs.TriEngine.UI.IControlManager.

        {
            RemoveAllControls(c => c.GetType() == type);
        }

void TriDevs.TriEngine.UI.ControlManager.RemoveAllControls

(

Func< IControl, bool >

func

)

Removes all controls matching the supplied predicate function.

Parameters

func	The predicate function to use.

Implements TriDevs.TriEngine.UI.IControlManager.

        {
            var toRemove = _controls.Where(func);
            var controls = toRemove as IList<IControl> ?? toRemove.ToList();
            if (controls.Count < 0)
                return;
            controls.ToList().ForEach(c =>
            {
                c.Hide();
                c.Disable();
            });
            _controls.RemoveAll(c => func(c));
        }

void TriDevs.TriEngine.UI.ControlManager.RemoveControl

(

IControl

control

)

Removes a control from this control manager.

Parameters

control

The control to remove.

Implements TriDevs.TriEngine.UI.IControlManager.

        {
            if (!HasControl(control))
                return;
            var match = _controls.FirstOrDefault(c => c == control);
            if (match == null)
                return;
            match.Hide();
            match.Disable();
            _controls.Remove(match);
        }

Here is the call graph for this function:

void TriDevs.TriEngine.UI.ControlManager.Update

(

)

Updates the object.

Implements TriDevs.TriEngine.Interfaces.IUpdatable.

        {
            _controls.ForEach(c => c.Update());
        }

Property Documentation

bool TriDevs.TriEngine.UI.ControlManager.Enabled

getset

---

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

• TriDevs.TriEngine/UI/ControlManager.cs