Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET
Control class intended to be used as a simple GuiLayer.

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 FormLayer : Control, IFormLayer, 
	IControl, IComponentOwner, IAttachmentSite, IAsset, IPrototyped, 
	IInstanced, IRegistered, IHandleProvider, IHasUniqueName, IAssetDragDrop, 
	IActivity, IActivated, IDisposable, IHasNameID, INamed, 
	IOwned, IInitialized, IUpdated
Public Class FormLayer _
	Inherits Control _
	Implements IFormLayer, IControl, IComponentOwner, IAttachmentSite,  _
	IAsset, IPrototyped, IInstanced, IRegistered, IHandleProvider,  _
	IHasUniqueName, IAssetDragDrop, IActivity, IActivated, IDisposable,  _
	IHasNameID, INamed, IOwned, IInitialized, IUpdated

Members

                  
 All Members  Constructors   Fields   Properties   Methods   Events  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
FormLayer(GuiForm, ControlConfig, GuiStyle)
Initializes a new instance of the FormLayer class
AbsoluteToRelative(ScreenPoint) (Inherited from Control.)
AbsoluteToRelative(ScreenRectangle) (Inherited from Control.)
AbsoluteToRelative(ScreenSize) (Inherited from Control.)
AbsoluteToRelativeX(Single) (Inherited from Control.)
AbsoluteToRelativeY(Single) (Inherited from Control.)
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 (Inherited from Entity.)
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.)
AddChild(String)
Add the named Control as a child of this Control. If the Control \a name is already attached to a Control, it is detached before being added to this Control.
(Inherited from Control.)
AddChild(Control)
Add the specified Control as a child of this Control. If the Control is already attached to a Control, it is detached before being added to this Control.
(Inherited from Control.)
Alpha
Get/Set the current alpha value for this Control.
(Inherited from Control.)
AlphaChanged (Inherited from Control.)
AlphaScalar
Scales Alpha by an additional amount.
(Inherited from Control.)
AlwaysOnTop
Gets/Sets whether this Control is 'always on top' or not. If not, it follows normal Z-order behavior.
(Inherited from Control.)
AlwaysOnTopChanged (Inherited from Control.)
AnchorInfo
Gets/Sets Gui Anchor information.
(Inherited from Control.)
AnchorRelativeOffset
Gets/Sets Gui Relative ScreenPoint Offset to Anchor to.
(Inherited from Control.)
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.)
CaptureGained (Inherited from Control.)
CaptureInput()()()()
Capture input to this control.
(Inherited from Control.)
CaptureLost (Inherited from Control.)
Character (Inherited from Control.)
ChildAdded (Inherited from Control.)
ChildControlCount
Gets the number of child Controls attached to this Control.
(Inherited from Control.)
ChildControls (Inherited from Control.)
ChildOwner (Inherited from Entity.)
ChildRemoved (Inherited from Control.)
ClippingChanged (Inherited from Control.)
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.)
ControlToScreenArea(ScreenRectangle)
Convert a control Area, to a Screen-based Area.
(Inherited from Control.)
ControlToScreenPoint(ScreenPoint)
Convert a control Point to a Screen Point.
(Inherited from Control.)
ControlToScreenX(Single)
Convert a control X coordinate value to a screen X coordinate.
(Inherited from Control.)
ControlToScreenY(Single)
Convert a control Y coordinate to Screen Y coordinate.
(Inherited from Control.)
CreateIdentity()()()() (Inherited from Registered.)
CreateIdentityList()()()() (Inherited from Registered.)
CreateInstance(Boolean) (Inherited from Control.)
CreateService<(Of <<'(TService>)>>)()()()() (Inherited from ComponentBase.)
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
Designer (Inherited from Control.)
DesignLocationChanged (Inherited from Control.)
DestroyedByParent
Get/Set whether or not this Control will automatically be destroyed when its parent Control is destroyed.
(Inherited from Control.)
DestructionStarted (Inherited from Control.)
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.)
EffectiveAlpha
Gets the effective alpha value that will be used when rendering this Control, taking into account inheritance of parent Control(s) alpha. Range 0-1F
(Inherited from Control.)
EntityBase (Inherited from Entity.)
FindAllChildren(ControlList)
Returns a list of all controls which are descendants of this control.
(Inherited from Control.)
Focus()()()()
Set focus on this control and bring to top of all non always-on-top Controls.
(Inherited from Control.)
FocusedChild
Gets a reference to the bottom-most active child Control starting at 'this', else null if Focus is not contained by this control or it's children.
(Inherited from Control.)
Font
Returns reference to the active Font for this Control, else returns Default Font is not specifically assigned.
(Inherited from Control.)
FontChanged (Inherited from Control.)
FontName (Inherited from Control.)
ForEachComponent<(Of <<'(TComponent>)>>)(Action<(Of <<'(TComponent>)>>)) (Inherited from Entity.)
FullName
The unique name of this Control.
(Inherited from Control.)
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.)
GetAssetInstance()()()() (Inherited from Control.)
GetChild(String)
Return a reference to the child Control with the specified name.
(Inherited from Control.)
GetChildAtIndex(Int32)
Gets a reference to the child Control at the specified index.
(Inherited from Control.)
GetChildAtPosition(ScreenPoint)
Returns the child Control that is 'hit' by the given position
(Inherited from Control.)
GetContainerAtPosition(Control, ScreenPoint)
Returns the child container Control that is 'hit' by the given position
(Inherited from Control.)
GetDesignerControlAtPosition(ScreenPoint) (Inherited from Control.)
GetDesignerSheetAtPosition(ScreenPoint) (Inherited from Control.)
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.)
GetService<(Of <<'(TService>)>>)()()()() (Inherited from ComponentBase.)
GetService<(Of <<'(TService>)>>)(TService%) (Inherited from ComponentBase.)
GetTextExtent()()()()
Gets the width in pixels of the current control text.
(Inherited from Control.)
GotFocus (Inherited from Control.)
GuiElementType (Overrides Control..::..GuiElementType.)
GuiElementTypeName (Inherited from Control.)
Handle (Inherited from Registered.)
HandleDragDrop(IAssetDragDropEventArgs) (Inherited from Control.)
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
Gets/Sets the height of the Control (in unspecified units).
(Inherited from Control.)
Hide()()()()
Hide this control.
(Inherited from Control.)
ID (Inherited from Registered.)
IDChanged (Inherited from Registered.)
IDChanged (Inherited from Control.)
InheritsAlpha
Get/Set whether this Control will inherit alpha from its parent Controls.
(Inherited from Control.)
InheritsAlphaChanged (Inherited from Control.)
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(IComponentOwner) (Inherited from Entity.)
Initialized (Inherited from Entity.)
InnerRect
Gets a Rect describing the clipped inner area for this Control.
(Inherited from Control.)
IsActive (Inherited from Entity.)
IsActiveNonDisposed (Inherited from Entity.)
IsCapturedByChild
Returns true if input is captured by a child of 'this'.
(Inherited from Control.)
IsCapturedByThis
Returns true if input is captured by 'this'.
(Inherited from Control.)
IsClippedByParent
Returns true if this Control is to be clipped by it's parent.
(Inherited from Control.)
IsContainer (Overrides Control..::..IsContainer.)
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.)
IsDragging
Indicates if control is currently being dragged.
(Inherited from Control.)
IsDraggingChanged (Inherited from Control.)
IsDraggingEnabled
Get/Set whether this Control will respond to dragging.
(Inherited from Control.)
IsEditable
Indicates if Control is Editable via the GuiDesigner mode.
(Inherited from Control.)
IsFocused
Returns true if this Control is Focused.
(Inherited from Control.)
IsHit(ScreenPoint)
Check if the given Screen position would hit this Control.
(Inherited from Control.)
IsInitialized
Gets if this entity is currently in an initialized (and non-disposed) state.
(Inherited from Asset.)
IsInputEnabled
Returns true if this Control is currently processing Input.
(Inherited from Control.)
IsInputEnabledChanged (Inherited from Control.)
IsPointOverControl(ScreenPoint) (Inherited from Control.)
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.)
IsToolTipActive (Inherited from Control.)
IsVisible
Returns true if this Control is visible (not hidden).
(Inherited from Control.)
IsVisibleChanged (Inherited from Control.)
KeyDown (Inherited from Control.)
KeyUp (Inherited from Control.)
Location
Value is only valid when gui is in design mode
(Inherited from Control.)
LostFocus (Inherited from Control.)
MaximumSize
Get/Set the maximum size for this Control.
(Inherited from Control.)
MinimumSize
Set the minimum size for this Control.
(Inherited from Control.)
MouseButtonDown (Inherited from Control.)
MouseButtonUp (Inherited from Control.)
MouseClicked (Inherited from Control.)
MouseCursorImage
Get a reference to the mouse cursor image to use when the mouse is within this Control.
(Inherited from Control.)
MouseDoubleClicked (Inherited from Control.)
MouseEnters (Inherited from Control.)
MouseLeaves (Inherited from Control.)
MouseMove (Inherited from Control.)
MouseTripleClicked (Inherited from Control.)
MouseWheel (Inherited from Control.)
Moved (Inherited from Control.)
MoveToBack()()()()
Move the Control to the bottom of the Z order.
(Inherited from Control.)
MoveToFront()()()()
Move the Control to the top of the z order.
(Inherited from Control.)
Name (Inherited from EntityComponent.)
NameID (Inherited from EntityComponent.)
NotifyComponentsOfEvent<(Of <<'(TEvent>)>>)(TEvent) (Inherited from Entity.)
OffsetPixelPosition(ScreenPoint)
Move the window by the pixel offsets specified in offset.
(Inherited from Control.)
OnMemberwiseClone()()()() (Inherited from ComponentBase.)
Owner (Inherited from Entity.)
OwnerActivated(IComponentOwner) (Inherited from EntityComponent.)
OwnerDeactivated(IComponentOwner) (Inherited from EntityComponent.)
OwnerEntity (Inherited from Entity.)
OwnerOf<(Of <<'(TOwner>)>>)()()()() (Inherited from Registered.)
ParentControl
Gets/Sets a reference to this Control's parent Control.
(Inherited from Control.)
ParentDestroyChanged (Inherited from Control.)
ParentForm (Overrides Control..::..ParentForm.)
ParentSized (Inherited from Control.)
PerformClick()()()() (Inherited from Control.)
PixelRect
Gets a Rect describing the Control area in pixel screen space.
(Inherited from Control.)
Position
Get/Set the pixel position of the Control.
(Inherited from Control.)
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
Gets a Rect object that describes the Control area.
(Inherited from Control.)
RelativeToAbsolute(ScreenPoint) (Inherited from Control.)
RelativeToAbsolute(ScreenRectangle) (Inherited from Control.)
RelativeToAbsolute(ScreenSize) (Inherited from Control.)
RelativeToAbsoluteX(Single) (Inherited from Control.)
RelativeToAbsoluteY(Single) (Inherited from Control.)
ReleaseInput()()()()
Releases the capture of input from this control.
(Inherited from Control.)
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.)
RemoveChild(String)
Removes the child Control with the specified name.
(Inherited from Control.)
RemoveChild(Control)
Removes 'Control' from this Control's child list.
(Inherited from Control.)
RenameKey(NameID, NameID) (Inherited from Entity.)
Render()()()()
Renders Control and all of it's attached children.
(Inherited from Control.)
RenderingEnded (Inherited from Control.)
RenderingStarted (Inherited from Control.)
ReplaceAction(ActionBase) (Inherited from Entity.)
ReplaceAction(NameID, ActionBase) (Inherited from Entity.)
RequestRedraw()()()()
Signal the System object to redraw (at least) this Control on the next render cycle.
(Inherited from Control.)
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.)
ResolutionChanged (Inherited from Control.)
RotationAngle
Get/Set the rotation of the Control between 0 and 360 degrees.
(Inherited from Control.)
RotationAngleChanged (Inherited from Control.)
Scheduler (Inherited from Entity.)
SchedulerID (Inherited from Entity.)
Scope (Inherited from Registered.)
ScreenToControlArea(ScreenRectangle)
Convert a screen area to a control area, specified in whichever metrics mode is active.
(Inherited from Control.)
ScreenToControlPoint(ScreenPoint)
Convert Screen Point to Control-based Point.
(Inherited from Control.)
ScreenToControlX(Single)
Convert Screen X coordinate to a control-based X coordinate.
(Inherited from Control.)
ScreenToControlY(Single)
Convert Screen Y coordinate to a control-based Y coordinate.
(Inherited from Control.)
Set<(Of <<'(T>)>>)(T) (Inherited from Entity.)
Set(Type, Object) (Inherited from Entity.)
Set(NameID, Object) (Inherited from Entity.)
SetAreaRect(ScreenRectangle)
Set the current area for the Control, this allows for setting of position and size at the same time. Interpretation of the input value area is dependant upon the current metrics system set for the Control.
(Inherited from Control.)
SetFont(String)
Set the font used by this Control to the font associated with the font name (or Default Font, if null name).
(Inherited from Control.)
SetFont(Font)
Set the font used by this Control, will use Default if font is null.
(Inherited from Control.)
SetMouseCursor(Image)
Sets the mouse cursor to use when the mouse is hovering over this control.
(Inherited from Control.)
SetMouseCursor(String, String)
Set the mouse cursor image to be used when the mouse enters this control.
(Inherited from Control.)
SetRestoreCapture(Boolean)
Sets the 'restore old capture' mode to on / off.
(Inherited from Control.)
SetToolTip(ToolTipBox) (Inherited from Control.)
Show()()()()
Show this control (make visible).
(Inherited from Control.)
Size
Get/Set the pixel size of this Control.
(Inherited from Control.)
SizeChanged (Inherited from Control.)
SourceFile
Gets/Sets the source file for this program.
(Inherited from Asset.)
StopDragging()()()() (Inherited from Control.)
StorageModule (Inherited from Registered.)
Tag
Gets or sets the object that contains data about the control.
(Inherited from Control.)
Text
Gets/Sets the Control's text string.
(Inherited from Control.)
TextChanged (Inherited from Control.)
TextColor
Gets/Sets the Control's text color.
(Inherited from Control.)
TextColorChanged (Inherited from Control.)
ThemeFileName
ToggleVisibility()()()()
Toggle the controls visibility.
(Inherited from Control.)
ToolTip (Inherited from Control.)
ToString()()()() (Overrides Control..::..ToString()()()().)
TriggerAIEvent(BaseEvent) (Inherited from Entity.)
TriggerEvent(BaseEvent) (Inherited from Entity.)
UnclippedInnerRect
Return a Rect that describes, unclipped, the inner rectangle for this Control. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.
(Inherited from Control.)
UnclippedPixelRect
Gets a Rect describing the Control area unclipped, in screen space.
(Inherited from Control.)
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
Gets/Sets the width of the Control (in unspecified units).
(Inherited from Control.)
X
Get/Set the x position of the Control relative to it's parent.
(Inherited from Control.)
Y
Get/Set the y position of the Control relative to it's parent.
(Inherited from Control.)
ZChanged (Inherited from Control.)

Remarks

This class does no rendering of its own and so appears totally transparent. This Control defaults to position 0.0f, 0.0f with a size of 1.0f x 1.0f - and so covers the entire display.

Inheritance Hierarchy

System..::..Object
  Visual3D.EntityModel..::..ComponentBase
    Visual3D.EntityModel..::..EntityComponent
      Visual3D..::..Registered
        Visual3D..::..Asset
          AssetOwner
            Visual3D..::..Entity
              Visual3D.UI..::..Control
                Visual3D.UI..::..FormLayer

See Also