Visual3D Game Engine API Documentation for XNA, C#, VB, and .NET

Encapsulates a rendered Graphical User Interface, which can stand alone, and be shown/hidden or enabled/disabled individually. It is also capable of handling it's own input events, or delegating them to be handled by an outside InputProcessor.

Namespace: Visual3D.UI
Assembly: Visual3D.UI (in Visual3D.UI.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax


	C#			Visual Basic

public class GuiForm : Entity, IGuiForm, 
	IComponentOwner, IAttachmentSite, IAsset, IPrototyped, IInstanced, 
	IRegistered, IHandleProvider, IHasUniqueName, IAssetDragDrop, IAssetItem, 
	IActivity, IActivated, IDisposable, IHasNameID, IOwned, 
	IInitialized, IUpdated, IForm, INamed, IInputHandler, 
	IKeyEventHandler, IAssetRegistrationCallback, IAttachable, IHasGroupFolder

Public Class GuiForm _
	Inherits Entity _
	Implements IGuiForm, IComponentOwner, IAttachmentSite, IAsset,  _
	IPrototyped, IInstanced, IRegistered, IHandleProvider, IHasUniqueName,  _
	IAssetDragDrop, IAssetItem, IActivity, IActivated, IDisposable,  _
	IHasNameID, IOwned, IInitialized, IUpdated, IForm,  _
	INamed, IInputHandler, IKeyEventHandler, IAssetRegistrationCallback, IAttachable,  _
	IHasGroupFolder

Members

All Members

Constructors Public method

Fields

Properties Public property

Methods

Events

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	GuiForm()()()()	Initializes a new instance of the GuiForm class
	GuiForm(String, Boolean, ScreenRectangle)	Initializes a new instance of the GuiForm class
	GuiForm(String, Boolean, ScreenRectangle, Boolean)	Initializes a new instance of the GuiForm class
	ActionIsActive(NameID)	(Inherited from Entity.)
	Activate()()()()	Enables an entity and its scripted or diagrammed interactivity. (Inherited from Entity.)
	Activate(IComponentOwner)	Sets activity Owner and then Activates this activity. (Inherited from Entity.)
	ActivateAction(ActionBase)	(Inherited from Entity.)
	ActivateAction(NameID)	(Inherited from Entity.)
	Activated	(Inherited from Entity.)
	ActivationFrameNumber
	Activities	(Inherited from Entity.)
	Add(Object)	(Inherited from Entity.)
	Add(Type, Object)	(Inherited from Entity.)
	Add(NameID, Object)	(Inherited from Entity.)
	AddAction(ActionBase)	(Inherited from Entity.)
	AddAction(NameID, ActionBase)	(Inherited from Entity.)
	AddButton(String, String, Single, Single, Single)	Adds a PushButton element to this GUI and initializes it.
	AddButton(NameID, String, Single, Single, Single)
	AddButton(String, String, Single, Single, Single, Boolean)	Adds a PushButton element to this GUI and initializes it.
	AddButton(NameID, String, Single, Single, Single, Boolean)
	AddButton(String, String, Single, Single, Single, Boolean, Boolean)	Adds a PushButton element to this GUI and initializes it.
	AddButton(NameID, String, Single, Single, Single, Boolean, Boolean)
	AddButton(String, String, Single, Single, Single, Single, Boolean, Boolean)	Adds a PushButton element to this GUI and initializes it.
	AddButton(NameID, String, Single, Single, Single, Single, Boolean, Boolean)
	AddButton(String, String, String, Single, Single, Single, Single, Boolean, Boolean)	Adds a PushButton element to this GUI and initializes it.
	AddButton(NameID, String, String, Single, Single, Single, Single, Boolean, Boolean)
	AddChatBox(String, Single, Single, Single, Single, String)
	AddChatBox(NameID, Single, Single, Single, Single, String)
	AddCheckBox(String, String, Single, Single, Single, Single, Boolean)	Create a Static Text child element for this GUI.
	AddCheckBox(NameID, String, Single, Single, Single, Single, Boolean)
	AddCheckBox(String, String, Single, Single, Single, Single, Boolean, Single, Single)	Create a Static Text child element for this GUI.
	AddCheckBox(NameID, String, Single, Single, Single, Single, Boolean, Single, Single)
	AddColorProgressBar(String, Single, Single, Single, Single, Single, Single, Single, ProgressBarConfig..::..Orientation)	Create a Static Text child element for this GUI.
	AddColorProgressBar(NameID, Single, Single, Single, Single, Single, Single, Single, ProgressBarConfig..::..Orientation)
	AddComboBox(String, Single, Single, Single, Single, String)	Create a Static Text child element for this GUI with left justified alignment.
	AddComboBox(NameID, Single, Single, Single, Single, String)
	AddComboDropList(String, Single, Single, Single, Single, String)
	AddComboDropList(NameID, Single, Single, Single, Single, String)
	AddControl(Control)
	AddDropBox(NameID, String, String, Single, Single, Single, Single, Boolean, Boolean)
	AddEditBox(String, Single, Single, Single, Single, String)	Create a Static Text child element for this GUI with left justified alignment.
	AddEditBox(NameID, Single, Single, Single, Single, String)
	AddHotKey(IKeyEventHandler, KeyMapEntry)	(Inherited from IKeyEventHandlerExtensions.)
	AddHotKey(IKeyEventHandler, Key, NameID, ModifierKeys)	(Inherited from IKeyEventHandlerExtensions.)
	AddHotKey(IKeyEventHandler, Key, NameID, Boolean, ModifierKeys)	(Inherited from IKeyEventHandlerExtensions.)
	AddHotKey(IKeyEventHandler, Key, NameID, KeyEventTypes, ModifierKeys)	(Inherited from IKeyEventHandlerExtensions.)
	AddHotKey(IKeyEventHandler, Key, NameID, KeyEventTypes, ModifierKeyDependencies)	(Inherited from IKeyEventHandlerExtensions.)
	AddHotKeys(IKeyEventHandler, array<KeyMapEntry>[]()[][])	(Inherited from IKeyEventHandlerExtensions.)
	AddHudImage(IMapMark, String, Single, Single, Single, Single, String, String)	Create a Static Image object for this GUI directly from file.
	AddImage(String, Single, Single, String)	Create a Static Image object for this GUI directly from file.
	AddImage(String, Single, Single, String, String)	Create a Static Image object for this GUI directly from file.
	AddImage(String, String, Single, Single, Single, Single)	Create a Static Image object for this GUI
	AddImage(NameID, String, Single, Single, Single, Single)
	AddImage(String, Single, Single, Single, Single, String, String)
	AddImage(String, String, String, Single, Single, Single, Single)	Create a Static Image object for this GUI
	AddImage(NameID, Single, Single, Single, Single, String, String)
	AddImage(NameID, String, String, Single, Single, Single, Single)
	AddInventoryWindow(NameID, String, Single, Single, Single, Single, Boolean, Boolean, SimpleMethod)
	AddKeyHeldTrigger(IKeyEventHandler, Key, NameID)	(Inherited from IKeyEventHandlerExtensions.)
	AddKeyHeldTrigger(IKeyEventHandler, Key, NameID, ModifierKeys)	(Inherited from IKeyEventHandlerExtensions.)
	AddListBox(String, Single, Single, Single, Single, String)
	AddListBox(NameID, Single, Single, Single, Single, String)
	AddParentFrameWindow(String, String, Single, Single, Single, Single, Single, Boolean, Boolean, SimpleMethod)	Add a Parent Window to this GUI. If first parent, it becomes TopWindow.
	AddParentFrameWindow(NameID, String, Single, Single, Single, Single, Single, Boolean, Boolean, SimpleMethod)
	AddParentGuiLayer(NameID, Single, Single, Single, Single)	Adds a GuiLayer to the current GUI as a Parent Control.
	AddParentGuiLayer(NameID, Single, Single, Single, Single, Boolean)	Adds a GuiLayer to the current GUI as a Parent Control.
	AddParentScrollFrameWindow(String, String, Single, Single, Single, Single, Single, Boolean, Boolean, SimpleMethod)	Add a Parent Window to this GUI. If first parent, it becomes TopWindow.
	AddProgressBar(NameID, Single, Single, Single, Single, Single, Single, Single, ProgressBarConfig..::..Orientation)	Create a Static Text child element for this GUI.
	AddRadio(String, String, Single, Single, Single, Single, Boolean)	Adds a Radio button element to this GUI and initializes it.
	AddRadio(NameID, String, Single, Single, Single, Single, Boolean)
	AddRadio(String, String, Single, Single, Single, Single, Boolean, Single, Single)	Adds a Radio button element to this GUI and initializes it.
	AddRadio(NameID, String, Single, Single, Single, Single, Boolean, Single, Single)
	AddSlider(String, Single, Single, Single)	Create a Static Text child element for this GUI.
	AddSlider(NameID, Single, Single, Single)
	AddSlider(String, Single, Single, Single, Single, Single)	Create a Static Text child element for this GUI.
	AddSlider(NameID, Single, Single, Single, Single, Single)
	AddSubGui(GuiForm, Single, Single, Single, Single, Boolean)
	AddSubGui(NameID, Single, Single, Single, Single, Boolean)
	AddText(String, Single, Single, Single, Single, String)	Create a Static Text child element for this GUI with left justified alignment.
	AddText(NameID, Single, Int32%, Single, Int32, array<String>[]()[][])	Create a Static Text child element for this GUI with left justified alignment.
	AddText(NameID, Single, Single, Single, Single, String)
	AddText(String, Single, Single, Single, Single, String, HorizontalTextAlignment)	Create a Static Text child element for this GUI, and allow caller to set non-default Horizontal Text format (default is Left justified).
	AddText(NameID, Single, Single, Single, Single, String, HorizontalTextAlignment)
	AddToolTipWindow(String, String, String, Single, Single, Single, Single, Single, Boolean, SimpleMethod)	Create a ToolTip window object for this GUI
	AddToolTipWindow(NameID, String, String, Single, Single, Single, Single, Single, Boolean, SimpleMethod)
	AddVerticalScrollBar(String, Single, Single, Single, Single, String)
	AddVerticalScrollBar(NameID, Single, Single, Single, Single, String)
	AlphaIsInheritedByDefault
	ApplyTheme()()()()
	AssetID	(Inherited from Registered.)
	AssetInfo	(Inherited from Registered.)
	AssetOwner	Gets or sets the owner to which this asset belongs and is a member of. (Inherited from Asset.)
	Attach(Object)	(Inherited from Entity.)
	AttachedToOwner(IComponentOwner)	(Inherited from EntityComponent.)
	BaseAsset	(Inherited from Registered.)
	CanAttach(Object)	(Inherited from Entity.)
	CanDetach(Object)	(Inherited from Entity.)
	ChildOwner	(Inherited from Entity.)
	ComponentOwner	Owner of this component (contained in it's ".Components" container). (Inherited from EntityComponent.)
	Components	Components that are attached to this Entity. (Inherited from ComponentBase.)
	ComponentsForGlobalSceneFolders	(Inherited from ComponentBase.)
	ContainsAction(NameID)	(Inherited from Entity.)
	Context	Defines the Owner of this component as well as the role (i.e. 'slot') that this component fulfills. (Inherited from ComponentBase.)
	CreateGuiLayer(String, Single, Single, Single, Single, Boolean)	Create a GuiLayer and add it to the guiElements list.
	CreateIdentity()()()()	(Inherited from Registered.)
	CreateIdentityList()()()()	(Inherited from Registered.)
	CreateInstance(Boolean)	Creates an instance or non-inheriting duplicate of this asset. (Inherited from Asset.)
	CreateService<(Of <<'(TService>)>>)()()()()	(Inherited from ComponentBase.)
	CreateSubGui(GuiForm, Object, Single, Single, Single, Single, Boolean)	Create a GuiLayer and add it to the guiElements list.
	Deactivate()()()()	Disables an entity and its scripted or diagrammed interactivity, if it is currently enabled. (Inherited from Entity.)
	DeactivateAction(NameID)	(Inherited from Entity.)
	Deactivated	(Inherited from Entity.)
	DesignBackgroundColor
	Detach(Object)	(Inherited from Entity.)
	DetachedFromOwner(IComponentOwner)	(Inherited from EntityComponent.)
	Dispose()()()()	(Inherited from ComponentBase.)
	Disposed	Triggered anytime SceneObject Visibility is changed. (Inherited from Entity.)
	Do(ActionBase)	(Inherited from Entity.)
	EntityBase	(Inherited from Entity.)
	ForEachComponent<(Of <<'(TComponent>)>>)(Action<(Of <<'(TComponent>)>>))	(Inherited from Entity.)
	Get<(Of <<'(T>)>>)()()()()	(Inherited from Entity.)
	Get<(Of <<'(T>)>>)(T%)	(Inherited from Entity.)
	Get<(Of <<'(TKey, TDerived>)>>)(TDerived%)	(Inherited from Entity.)
	Get<(Of <<'(T>)>>)(NameID)	(Inherited from Entity.)
	Get(NameID, Object%)	(Inherited from Entity.)
	Get<(Of <<'(T>)>>)(NameID, T%)	(Inherited from Entity.)
	GetAction(NameID)	(Inherited from Entity.)
	GetActions()()()()	(Inherited from Entity.)
	GetAll<(Of <<'(TComponent>)>>)()()()()	(Inherited from Entity.)
	GetControlByName(String)	Get the GuiElement with the specified name.
	GetGroupFolder(String)
	GetOrCreate<(Of <<'(K, T>)>>)()()()()	(Inherited from Entity.)
	GetOrCreate<(Of <<'(K, T>)>>)(T%)	(Inherited from Entity.)
	GetOrCreate<(Of <<'(T>)>>)(T%)	(Inherited from Entity.)
	GetOrCreate<(Of <<'(T>)>>)(NameID, T%)	(Inherited from Entity.)
	GetSavedPlacement()()()()
	GetService<(Of <<'(TService>)>>)()()()()	(Inherited from ComponentBase.)
	GetService<(Of <<'(TService>)>>)(TService%)	(Inherited from ComponentBase.)
	GuiControls
	GuiControlsCollection
	GuiScreen	Specifies the target where this Gui will be shown.
	Handle	(Inherited from Registered.)
	HandleInputEvent(IInputHandler, InputEventArgs)
	HandleStillPressedEvent(Key, Int32, IInputHandler)
	HasComponents	(Inherited from ComponentBase.)
	HasHandle	(Inherited from Registered.)
	HasName	(Inherited from EntityComponent.)
	HasOwner<(Of <<'(TOwner>)>>)(IOwned)	(Inherited from EntityExtensions.)
	HasOwner<(Of <<'(TOwner>)>>)(IOwned, TOwner%)	(Inherited from EntityExtensions.)
	HasOwner<(Of <<'(TOwner>)>>)(IOwned, TOwner%, Boolean)	(Inherited from EntityExtensions.)
	HasPrototype	Gets if a prototype has been specified to inherit instance data from. (Inherited from Asset.)
	HasScope	(Inherited from Registered.)
	HasUniqueName	Gets if a UniqueName is specified to identify this asset with respect to its owner's other members. (Inherited from Registered.)
	Height
	Hide()()()()
	ID	(Inherited from Registered.)
	IDChanged	(Inherited from Registered.)
	Initialize()()()()	Initializes the asset so that it might be prepared for use. By default, PrepareForUse() is called from this method as well. (Inherited from Asset.)
	Initialize(GuiScreen)
	Initialize(IComponentOwner)
	Initialize(GuiScreen, IComponentOwner)
	Initialized	(Inherited from Entity.)
	InputHandler
	IsActive	(Inherited from Entity.)
	IsActiveNonDisposed	(Inherited from Entity.)
	IsDeserialized	Indicates if Instance was created by Deserialization. (Inherited from ComponentBase.)
	IsDisposed	Indicates if resource has been disposed. (Inherited from Asset.)
	IsDisposing	Indicates if resource is in process of Disposing but not fully disposed. (Inherited from Asset.)
	IsInitialized	Gets if this entity is currently in an initialized (and non-disposed) state. (Inherited from Asset.)
	IsInputEnabled
	IsModal	Indicates if associated GUI's will be Modal (i.e. exclusive).
	IsPrototype	(Inherited from Asset.)
	IsReadyForUse	Gets/sets if asset is ready to be used. Can be set to 'true' in class constructor in order to skip Preparation logic. (Inherited from Asset.)
	IsSaved	Indicates if the component is to be Saved when the owning context is saved (e.g. for components in your scene, this controls whether or not they are saved to the scene file when the scene is saved). Typically objects are 'Saved', unless they are transient to be programmatically created each time. (Inherited from ComponentBase.)
	IsSavedOnCreatingInstance	(Inherited from Asset.)
	IsSharedByScenes
	IsShowing
	IsShowingAllowed
	IsVisible	Indicates if the GUI is currently Visible (i.e. shown).
	KeyEvents
	KeyMap	Maps the Keyboard HotKeys to the associated Input Options.
	KeyMapName
	ManuallySelectControl(NameID)	Allows Gui Options to be selected Remotely.
	MinTimeBetweenSliderChangedEvents
	Name	(Inherited from EntityComponent.)
	NameID	(Inherited from EntityComponent.)
	NotifyComponentsOfEvent<(Of <<'(TEvent>)>>)(TEvent)	(Inherited from Entity.)
	OnCheckBoxChanged(Object, ControlEventArgs)	By default, is called when a Checkbox state is changed. Sets 'selectedOption'.
	OnClickButton(Object, GuiEventArgs)	By default, is called when a button is clicked, and Sets 'selectedOption'.
	OnHandleGuiEvent(GuiEventType, String)	Delegate used to handle Gui Event Processing. The CEGUI input events will all trigger the appropriate handler scriptMethod of this class (e.g. OnClickButton). The purpose of this class is to record this Gui Event and then pass control to the associated InputHandler for custom processing.
	OnHandleInputEvent(IInputHandler, InputEventArgs)
	OnMemberwiseClone()()()()	(Inherited from ComponentBase.)
	OnRadioChanged(Object, ControlEventArgs)	By default, is called when a Radio button is checked. Sets 'selectedOption'.
	OnSliderChanged(Object, ControlEventArgs)	Gui updates for slider value changes. Sets 'selectedOption'.
	OnWindowClosed(Object, ControlEventArgs)	Hide the window when it is closed just for fun.
	Owner	(Inherited from Entity.)
	OwnerActivated(IComponentOwner)	(Inherited from EntityComponent.)
	OwnerDeactivated(IComponentOwner)	(Inherited from EntityComponent.)
	OwnerEntity	(Inherited from Entity.)
	OwnerOf<(Of <<'(TOwner>)>>)()()()()	(Inherited from Registered.)
	ParentSheet	GuiLayer that this Gui has been attached to (as a child).
	Position	Normalized Screen Position of the Upper Left corner of this Gui's TopSheet.
	PrepareForUse()()()()	Attempts to prepare asset for use. To be sure, check "IsReadyForUse" after calling this method to ensure it's really ready for use before using it. (Inherited from Asset.)
	Prototype	Gets the prototype this instance or prototype was created from and inherits components and settings from. (Inherited from Entity.)
	Rectangle
	Remove<(Of <<'(T>)>>)()()()()	(Inherited from Entity.)
	Remove(Object)	(Inherited from Entity.)
	Remove(NameID)	(Inherited from Entity.)
	RemoveAction<(Of <<'(T>)>>)()()()()	(Inherited from Entity.)
	RemoveAction(NameID)	(Inherited from Entity.)
	RenameKey(NameID, NameID)	(Inherited from Entity.)
	ReplaceAction(ActionBase)	(Inherited from Entity.)
	ReplaceAction(NameID, ActionBase)	(Inherited from Entity.)
	Reset()()()()	Called from 'Activate()' method, or can be called manually. Should initialize custom state of the Activity. Note, that if the Activity is currently executing, this should have no effect upon the current Activity state. (Inherited from Entity.)
	ResetParentControl()()()()	Resets the Current Parent Control to the Top Sheet.
	Scene
	SceneUI
	Scheduler	(Inherited from Entity.)
	SchedulerID	(Inherited from Entity.)
	Scope	(Inherited from Registered.)
	Set<(Of <<'(T>)>>)(T)	(Inherited from Entity.)
	Set(Type, Object)	(Inherited from Entity.)
	Set(NameID, Object)	(Inherited from Entity.)
	SetCurrentControlContainer(Int32)
	SetCurrentControlContainer(String)	Find Gui Element with specified Name, and set it to become the new CurrentParent.
	SetElementText(String, String)	Allows Gui Element Display Texts to be set Remotely.
	Show()()()()
	Show(IComponentOwner)
	SourceFile	Gets/Sets the source file for this program. (Inherited from Asset.)
	StillPressedManager
	StorageModule	(Inherited from Registered.)
	Style
	SubGuis	List of Sub-Gui's (i.e. children of this one). They exist inside the context of this Gui instance, and will automatically be shown, hidden, and activated synchronously.
	TopSheet	Top-most control for this GUI. Set by first call to SetParentControl() scriptMethod.
	ToString()()()()	(Inherited from Entity.)
	TriggerAIEvent(BaseEvent)	(Inherited from Entity.)
	TriggerEvent(BaseEvent)	(Inherited from Entity.)
	UniqueName	(Inherited from Registered.)
	Update()()()()	Method to be called at a fixed interval (i.e. 'UpdateTimeInterval') by the scheduler to do regular update events. (Inherited from Entity.)
	UpdateTimeInterval	Time interval at which the 'Update()' will be called by the scheduler upon Activation of this Entity. (Inherited from Entity.)
	VisualEntity(Entity)	(Inherited from EntityExtensions.)
	Width
	XPosition
	YPosition

Inheritance Hierarchy

Syntax

Members

Inheritance Hierarchy

See Also