Class NoesisPanel

NoesisGUI integration panel.

Inheritance

object

NoesisPanel

NoesisFramebufferPanel

NoesisOverlayPanel

Implements

IDependencyObject

Inherited Members

Behavior.Family

Behavior.UpdateOrder

Component.Owner

Component.Managers

Component.ShouldBeActivated

Component.Clone()

Component.Attach(Entity)

Component.OnLoaded()

Component.OnActivated()

Component.Start()

Component.OnDeactivated()

PrefabInstanceObject.PrefabSource

PrefabInstanceObject.PrefabElementId

PrefabInstanceObject.IsPrefabInstance

PrefabInstanceObject.IsMissingPrefabSource

AttachableObject.AttachableStateChanged

AttachableObject.IsEnabled

AttachableObject.State

AttachableObject.IsLoaded

AttachableObject.IsAttached

AttachableObject.IsActivated

AttachableObject.IsStarted

AttachableObject.IsDestroyed

AttachableObject.Destroy()

AttachableObject.DependencyBroken()

DependencyObject.Dependencies

DependencyObject.OnDependencyRemoved

IdentifiableObject.Id

IdentifiableObject.IdHasChanged(Guid)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Evergine.NoesisGUI

Assembly: Evergine.NoesisGUI.dll

Syntax

public abstract class NoesisPanel : Behavior, IDependencyObject

Constructors

NoesisPanel()

Initializes a new instance of the NoesisPanel class.

Declaration

public NoesisPanel()

Fields

backgroundColor

Background color.

Declaration

protected Color backgroundColor

Field Value

Type	Description
Color

clearFlags

Clear flags.

Declaration

protected ClearFlags clearFlags

Field Value

Type	Description
ClearFlags

definedKeys

Defined keys.

Declaration

protected Array definedKeys

Field Value

Type	Description
Array

flipY

Flip at Y axis.

Declaration

protected bool flipY

Field Value

Type	Description
bool

frameworkElement

Xaml content.

Declaration

protected FrameworkElement frameworkElement

Field Value

Type	Description
FrameworkElement

graphicsContext

The graphics context.

Declaration

[BindService(true)]
protected GraphicsContext graphicsContext

Field Value

Type	Description
GraphicsContext

graphicsPresenter

The graphics presenter.

Declaration

[BindService(true)]
protected GraphicsPresenter graphicsPresenter

Field Value

Type	Description
GraphicsPresenter

height

Panel height.

Declaration

protected uint height

Field Value

Type	Description
uint

lastMouse

Last mouse position.

Declaration

protected Point lastMouse

Field Value

Type	Description
Point

lastStyle

Last style name.

Declaration

protected string lastStyle

Field Value

Type	Description
string

noesisService

The Noesis service.

Declaration

[BindService(false)]
protected NoesisService noesisService

Field Value

Type	Description
NoesisService

ppaaEnabled

PPAA filter enabled.

Declaration

protected bool ppaaEnabled

Field Value

Type	Description
bool

renderFlags

Render Flags.

Declaration

protected RenderFlags renderFlags

Field Value

Type	Description
RenderFlags

renderer

Noesis renderer.

Declaration

protected Renderer renderer

Field Value

Type	Description
Renderer

screenViewports

Screen viewports array.

Declaration

protected Viewport[] screenViewports

Field Value

Type	Description
Viewport[]

tessellationQuality

Noesis panel tesselation quality.

Declaration

protected TessellationMaxPixelError tessellationQuality

Field Value

Type	Description
TessellationMaxPixelError

view

The Noesis View.

Declaration

protected View view

Field Value

Type	Description
View

viewSettingsDirty

Sets when settings view is dirty.

Declaration

protected bool viewSettingsDirty

Field Value

Type	Description
bool

width

Panel width.

Declaration

protected uint width

Field Value

Type	Description
uint

xaml

Xaml content.

Declaration

protected string xaml

Field Value

Type	Description
string

Properties

BackgroundColor

Gets or sets the color of the background.

Declaration

[RenderProperty(CustomPropertyName = "Background Color", Tooltip = "The background color for the transparent areas in the XAML design.")]
public Color BackgroundColor { get; set; }

Property Value

Type	Description
Color

ClearFlags

Gets or sets the clear flags used for cleaning the frameBuffer in rendertarget mode.

Declaration

[RenderProperty(CustomPropertyName = "Clear Flags", Tooltip = "The clear flags for the panel.")]
public ClearFlags ClearFlags { get; set; }

Property Value

Type	Description
ClearFlags

Content

Gets the root of the loaded Xaml.

Declaration

public FrameworkElement Content { get; }

Property Value

Type	Description
FrameworkElement

DataContext

Gets or sets the panel DataContext.

Declaration

public object DataContext { get; set; }

Property Value

Type	Description
object

Display

Gets the display to obtains the inputs.

Declaration

protected Display Display { get; }

Property Value

Type	Description
Display

EnableKeyboard

Gets or sets a value indicating whether keyboard input management is enabled.

Declaration

[RenderProperty(CustomPropertyName = "Enable Keyboard", Tooltip = "Indicates whether the panel will receive keyboard events.")]
public bool EnableKeyboard { get; set; }

Property Value

Type	Description
bool

EnableMouse

Gets or sets a value indicating whether mouse input management is enabled.

Declaration

[RenderProperty(CustomPropertyName = "Enable Mouse", Tooltip = "Indicates whether the panel will receive mouse events.")]
public bool EnableMouse { get; set; }

Property Value

Type	Description
bool

EnableTouch

Gets or sets a value indicating whether touch input management is enabled.

Declaration

[RenderProperty(CustomPropertyName = "Enable Touch", Tooltip = "Indicates whether the panel will receive touch events.")]
public bool EnableTouch { get; set; }

Property Value

Type	Description
bool

FlipY

Gets or sets a value indicating whether to flip the Y axis in the UI.

Declaration

[RenderProperty(CustomPropertyName = "Flip Y", Tooltip = "Indicates whether to flip the Y axis in the UI.")]
public bool FlipY { get; set; }

Property Value

Type	Description
bool

FrameworkElement

Gets or sets FrameworkElement that will be used when this component is enabled.

Declaration

public FrameworkElement FrameworkElement { get; set; }

Property Value

Type	Description
FrameworkElement

Height

Gets or sets the render height.

Declaration

[RenderProperty(CustomPropertyName = "Height", Tooltip = "The panel render height.")]
public uint Height { get; set; }

Property Value

Type	Description
uint

PPAAEnabled

Gets or sets a value indicating whether if PPAA anti-aliasing mode is enabled.

Declaration

[RenderProperty(CustomPropertyName = "PPAA Anti-aliasing Mode", Tooltip = "The PPAA anti-aliasing mode that the panel will use when rendering vector graphics.")]
public bool PPAAEnabled { get; set; }

Property Value

Type	Description
bool

RenderFlags

Gets or sets the flags used for rendering debug purposes.

Declaration

[RenderProperty(CustomPropertyName = "Render Flags", Tooltip = "Flags used for rendering debug purposes.")]
public RenderFlags RenderFlags { get; set; }

Property Value

Type	Description
RenderFlags

TessellationQuality

Gets or sets the tessellation quality, which determines the quantity of triangles generated for vector shapes.

Declaration

[RenderProperty(CustomPropertyName = "Tessellation Quality", Tooltip = "The tessellation quality that the panel will apply when rendering vector graphics.")]
public TessellationMaxPixelError TessellationQuality { get; set; }

Property Value

Type	Description
TessellationMaxPixelError

TouchDeadzoneRadius

Gets or sets the deadzone radius for touch events.

Declaration

[RenderProperty(Tooltip = "The radius of the deadzone for touch events. Dragging interactions will not be sent to the panel until the touch reaches this distance from the initial touch point.")]
public float TouchDeadzoneRadius { get; set; }

Property Value

Type	Description
float

Width

Gets or sets the render width.

Declaration

[RenderProperty(CustomPropertyName = "Width", Tooltip = "The panel render width.")]
public uint Width { get; set; }

Property Value

Type	Description
uint

Xaml

Gets or sets the path to the XAML that will be loaded when this component is enabled.

Declaration

public string Xaml { get; set; }

Property Value

Type	Description
string

Methods

NoesisBegin(bool)

Begins the Noesis Drawing.

Declaration

protected virtual void NoesisBegin(bool restore)

Parameters

Type	Name	Description
bool	restore	True to restore previous Noesis state.

NoesisEnd()

Ends the Noesis drawing.

Declaration

protected virtual void NoesisEnd()

ObtainsDisplay()

Gets the current display.

Declaration

protected abstract Display ObtainsDisplay()

Returns

Type	Description
Display	The current display.

ObtainsViewSize(out uint, out uint)

Obtains the size of the view.

Declaration

protected abstract void ObtainsViewSize(out uint width, out uint height)

Parameters

Type	Name	Description
uint	width	The width.
uint	height	The height.

OnAttached()

Invoked when the object is attached to the system.

Declaration

protected override bool OnAttached()

Returns

Type	Description
bool	True if all is OK.

Overrides

Behavior.OnAttached()

OnDestroy()

Invoked when the object is going to be disposed.

Declaration

protected override void OnDestroy()

Overrides

Component.OnDestroy()

OnDetach()

Invoked when the object is detached.

Declaration

protected override void OnDetach()

Overrides

Behavior.OnDetach()

ProjectPointer(Point, out Point)

Get the projected position of a mouse or touch input.

Declaration

public abstract bool ProjectPointer(Point screen, out Point projected)

Parameters

Type	Name	Description
Point	screen	Input x.
Point	projected	Projected x.

Returns

Type	Description
bool	Whether the pointer intersected the plane.

RebuildPanel()

Rebuild the panel in the next update cycle.

Declaration

public void RebuildPanel()

RegisterRenderEvents()

Declaration

protected abstract void RegisterRenderEvents()

UnregisterRenderEvents()

Unregister to the necessary events to perform the render cycle.

Declaration

protected abstract void UnregisterRenderEvents()

Update(TimeSpan)

Update all methods required for this instance.

Declaration

protected override void Update(TimeSpan gameTime)

Parameters

Type	Name	Description
TimeSpan	gameTime	The current game time.

Overrides

Behavior.Update(TimeSpan)

UpdateCharEvent(KeyCharEventArgs)

Notifies that a key was translated to the corresponding character.

Declaration

public void UpdateCharEvent(KeyCharEventArgs e)

Parameters

Type	Name	Description
KeyCharEventArgs	e	The key character event arguments.

UpdateKeyDownEvent(Keys)

Raises KeyDown event for a key enumeration.

Declaration

public void UpdateKeyDownEvent(Keys key)

Parameters

Type	Name	Description
Keys	key	The key enumeration.

UpdateKeyUpEvent(Keys)

Raises KeyUp event for a key enumeration.

Declaration

public void UpdateKeyUpEvent(Keys key)

Parameters

Type	Name	Description
Keys	key	The key enumeration.

UpdateMouseButtonEvent(ref Point, ButtonState, MouseButtons)

Update the mouse button state.

Declaration

public void UpdateMouseButtonEvent(ref Point mousePos, ButtonState state, MouseButtons button)

Parameters

Type	Name	Description
Point	mousePos	The mouse position.
ButtonState	state	The current button state.
MouseButtons	button	The specific button.

UpdateMousePosition(ref Point)

Update the mouse position.

Declaration

public void UpdateMousePosition(ref Point mousePos)

Parameters

Type	Name	Description
Point	mousePos	The mouse position.

UpdateMouseScrollEvent(ref Point, int)

Update the scroll wheel of the mouse.

Declaration

public void UpdateMouseScrollEvent(ref Point mousePos, int scrollWheel)

Parameters

Type	Name	Description
Point	mousePos	The mouse position.
int	scrollWheel	The mouse scroll wheel value.

UpdateTouchEvent(ref Point, ButtonState, long)

Updates the panel by point coordinates.

Declaration

public void UpdateTouchEvent(ref Point positionInNoesisPanel, ButtonState touchState, long touchId)

Parameters

Type	Name	Description
Point	positionInNoesisPanel	Position in Noesis panel.
ButtonState	touchState	Current touch state.
long	touchId	Current touch id.

ViewTouchMove(ref Point, ulong)

Calls panel touch move methos if view attribute is set.

Declaration

public void ViewTouchMove(ref Point touchPosition, ulong touchId)

Parameters

Type	Name	Description
Point	touchPosition	Current touch position.
ulong	touchId	Touch id.

ViewTouchUp(ref Point, ulong)

Calls panel touch up methos if view attribute is set.

Declaration

public void ViewTouchUp(ref Point touchPosition, ulong touchId)

Parameters

Type	Name	Description
Point	touchPosition	Current touch position.
ulong	touchId	Touch id.

Events

OnViewCreated

Event raised when the Noesis view is created

Declaration

public event EventHandler<View> OnViewCreated

Event Type

Type	Description
EventHandler<View>

Implements

IDependencyObject

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)