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

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

Syntax


	C#			Visual Basic

public interface IControl : IComponentOwner, 
	IAttachmentSite, IAsset, IPrototyped, IInstanced, IRegistered, 
	IHandleProvider, IHasUniqueName, IAssetDragDrop, IActivity, IActivated, 
	IDisposable, IHasNameID, INamed, IOwned, IInitialized, 
	IUpdated

Public Interface IControl _
	Inherits IComponentOwner, IAttachmentSite, IAsset, IPrototyped,  _
	IInstanced, IRegistered, IHandleProvider, IHasUniqueName, IAssetDragDrop,  _
	IActivity, IActivated, IDisposable, IHasNameID, INamed,  _
	IOwned, IInitialized, IUpdated

Members


	All Members			Properties			Methods			Events

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	AbsoluteToRelative(ScreenPoint)
	AbsoluteToRelative(ScreenRectangle)
	AbsoluteToRelative(ScreenSize)
	AbsoluteToRelativeX(Single)
	AbsoluteToRelativeY(Single)
	Activate()()()()	Activates this component. (Inherited from IActivated.)
	Activate(IComponentOwner)	Called to activate (i.e. "Start") the Activity. For components, this is called when they become 'Active' in the scene. (Inherited from IActivity.)
	Activated	Event fires when the when the Activity becomes Activated. (Inherited from IActivity.)
	ActivationFrameNumber	(Inherited from IActivity.)
	ActiveChildIndex	Event fires when SpeedScalar is Changed. (Inherited from IActivity.)
	AddChild(String)
	AddChild(IControl)
	Alpha
	AlphaChanged
	AlwaysOnTop
	AlwaysOnTopChanged
	AnchorRelativeOffset
	AssetOwner	(Inherited from IAsset.)
	CaptureGained
	CaptureInput()()()()
	CaptureLost
	Character
	ChildAdded
	ChildControlCount
	ChildControls
	ChildOwner	Actual Owner of the Components (it often is this Owner, but sometimes can be another Owner). (Inherited from IComponentOwner.)
	ChildRemoved
	ClippingChanged
	Components	Components container. (Inherited from IComponentOwner.)
	ControlToScreenArea(ScreenRectangle)
	ControlToScreenPoint(ScreenPoint)
	ControlToScreenX(Single)
	ControlToScreenY(Single)
	CreateIdentity()()()()	(Inherited from IRegistered.)
	CreateIdentityList()()()()	(Inherited from IRegistered.)
	CreateInstance(Boolean)	(Inherited from IInstanced.)
	CreateInstance(Boolean)
	Deactivate()()()()	Deactivates this component. (Inherited from IActivated.)
	Deactivated	Event fires when the final execution of the activity completes, right after it becomes Deactivated. (Inherited from IActivity.)
	DesignLocationChanged
	DestroyedByParent
	DestructionStarted
	EffectiveAlpha
	FindAllChildren(IControlList)
	Focus()()()()
	FocusedChild
	FontChanged
	FontName
	FullName
	GetChild(String)
	GetChildAtIndex(Int32)
	GetChildAtPosition(ScreenPoint)
	GetContainerAtPosition(IControl, ScreenPoint)
	GetTextExtent()()()()
	GotFocus
	GuiElementType
	GuiElementTypeName
	Handle	Gets or sets the handle for the ID. (Inherited from IRegistered.)
	HandleChildActivityFinished(IActivity)	Called by child, just after Activity Finishes. (Inherited from IComponentOwner.)
	HandleChildActivityStarting(IActivity)	Called by child, just before Activation, to allow Parent to reject or accept the request. If accepted, will return the ChildIndex for this child, and if Rejected, will return -1. (Inherited from IComponentOwner.)
	HandleComponentAdded(Object)	Informs Owner that this component has just been Added to its 'Components' container. (Inherited from IComponentOwner.)
	HandleComponentRemoved(Object)	Informs Owner that this component has just been Removed to its 'Components' container. (Inherited from IComponentOwner.)
	HasHandle	(Inherited from IRegistered.)
	HasName	(Inherited from IRegistered.)
	HasOwner<(Of <<'(TOwner>)>>)(IOwned)	(Inherited from EntityExtensions.)
	HasOwner<(Of <<'(TOwner>)>>)(IOwned, TOwner%)	(Inherited from EntityExtensions.)
	HasOwner<(Of <<'(TOwner>)>>)(IOwned, TOwner%, Boolean)	(Inherited from EntityExtensions.)
	HasScope	(Inherited from IRegistered.)
	HasUniqueName	(Inherited from IRegistered.)
	Height
	Hide()()()()
	ID	Gets or sets the ID for this object, which defines its storage location and a globally unique (and persistent) object handle. (Inherited from IRegistered.)
	IDChanged	(Inherited from IRegistered.)
	IDChanged
	InheritsAlpha
	InheritsAlphaChanged
	Initialize()()()()	Calls logic to initialize this object instance. Upon success, IsInitialized must then become 'true'. (Inherited from IInitialized.)
	Initialize(IComponentOwner)	Called when Activity is first attached to an Owner, or upon completion of instantiation with Owner already set. (Inherited from IActivity.)
	InnerRect
	IsActive	Indicates if component is currently Active or not. Note that setting this to 'true' or 'false' must implicitly call the appropriate method, Activate()()()() or Deactivate()()()(). (Inherited from IActivated.)
	IsCapturedByChild
	IsCapturedByThis
	IsClippedByParent
	IsContainer
	IsDragging
	IsDraggingEnabled
	IsEditable
	IsFocused
	IsHit(ScreenPoint)
	IsInitialized	Indicates if this object instance has been Initialized yet (by calling Initialize()()()()). (Inherited from IInitialized.)
	IsInputEnabled
	IsInputEnabledChanged
	IsPointOverControl(ScreenPoint)
	IsToolTipActive
	IsVisible
	IsVisibleChanged
	KeyDown
	KeyUp
	Location
	LostFocus
	MaximumSize
	MinimumSize
	MouseButtonDown
	MouseButtonUp
	MouseClicked
	MouseDoubleClicked
	MouseEnters
	MouseLeaves
	MouseMove
	MouseTripleClicked
	MouseWheel
	Moved
	MoveToBack()()()()
	MoveToFront()()()()
	Name	(Inherited from INamed.)
	NameID	(Inherited from IHasNameID.)
	OffsetPixelPosition(ScreenPoint)
	Owner	(Inherited from IOwned.)
	ParentControl
	ParentDestroyChanged
	ParentForm
	ParentSized
	PerformClick()()()()
	PixelRect
	Position
	Prototype	(Inherited from IPrototyped.)
	Rectangle
	RelativeToAbsolute(ScreenPoint)
	RelativeToAbsolute(ScreenRectangle)
	RelativeToAbsolute(ScreenSize)
	RelativeToAbsoluteX(Single)
	RelativeToAbsoluteY(Single)
	ReleaseInput()()()()
	RemoveChild(String)
	RemoveChild(IControl)
	Render()()()()
	RenderingEnded
	RenderingStarted
	RequestRedraw()()()()
	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 IActivity.)
	ResolutionChanged
	RotationAngle
	RotationAngleChanged
	Scope	Gets or sets the member owner which serves as the ID scope of uniqueness and persistence location of this object's definition. (Inherited from IRegistered.)
	ScreenToControlArea(ScreenRectangle)
	ScreenToControlPoint(ScreenPoint)
	ScreenToControlX(Single)
	ScreenToControlY(Single)
	SetActivationFrameNumber(Int32)	(Inherited from IActivity.)
	SetAreaRect(ScreenRectangle)
	SetFont(String)
	SetMouseCursor(String, String)
	SetRestoreCapture(Boolean)
	SetToolTip(IToolTipBox)
	Show()()()()
	Size
	SizeChanged
	SourceFile	(Inherited from IAsset.)
	StopDragging()()()()
	StorageModule	Gets the StorageModule in which this object's definition will be saved, the root IMemberOwner representing the file where this object's definition is persisted. (Inherited from IRegistered.)
	Tag
	Text
	TextChanged
	TextColor
	TextColorChanged
	ToggleVisibility()()()()
	ToolTip
	UnclippedInnerRect
	UnclippedPixelRect
	UniqueName	(Inherited from IHasUniqueName.)
	UniqueName	(Inherited from IRegistered.)
	Update()()()()	Method that will be called by the Scheduler. (Inherited from IUpdated.)
	UpdateTimeInterval	Rate at which the 'Update()' method will be called, expressed as a TimeInterval for the time system of the selected Scheduler. (Inherited from IUpdated.)
	Width
	X
	Y
	ZChanged

Syntax

Members

See Also