Class VisualContentBaseControl

public class VisualContentBaseControl : ContentBaseControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IRendererControl, IGorgonNamedObject

Remarks

This base editor view is used to render custom content and provide controls/functionality for zooming, and panning that content. This content editor view takes a view model that implements the IVisualEditorContent interface.

Content plug in developers should inherit from this control to provide standardized functionality for viewing content via the GorgonGraphics, and Gorgon2D interfaces. This should help simplify plug in UI development and allow developers to focus on creating UIs for editing their content without having to worry about developing boilerplate code for view manipulation.

By default this control will render a background using a checkerboard texture to illustrate opacity. This can be overridden by the developer on the view model.

Constructors

| Edit this page View Source

VisualContentBaseControl()

Initializes a new instance of the VisualContentBaseControl class.

Declaration

public VisualContentBaseControl()

Properties

| Edit this page View Source

RenderWindow

Property to return the panel that will be used to receive content rendering.

Declaration

[Browsable(false)]
public Panel RenderWindow { get; }

Property Value

Type	Description
Panel

| Edit this page View Source

Renderer

Property to return the current renderer.

Declaration

[Browsable(false)]
protected IContentRenderer Renderer { get; }

Property Value

Type	Description
IContentRenderer

| Edit this page View Source

ShowHorizontalScrollBar

Property to set or return whether horizontal scrolling is supported.

Declaration

[Browsable(true)]
public bool ShowHorizontalScrollBar { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

ShowVerticalScrollBar

Property to set or return whether vertical scrolling is supported.

Declaration

[Browsable(true)]
public bool ShowVerticalScrollBar { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

StatusPanel

Property to return the panel that will be used for presentation of the content.

Declaration

[Browsable(false)]
public Panel StatusPanel { get; }

Property Value

Type	Description
Panel

Methods

| Edit this page View Source

AddRenderer(string, IContentRenderer)

Function to register a new renderer with the view.

Declaration

protected void AddRenderer(string name, IContentRenderer renderer)

Parameters

Type	Name	Description
string	name	The name of the renderer.
IContentRenderer	renderer	The renderer to register.

Remarks

Some content plug ins will require the rendered view to change depending on state. For example, a specific tool is selected and the view needs to switch to a portion of the content. In such cases it is not practical to have a single renderer performing all manner of state changes, so this method provides a means of passing different renderer instances to the view.

Developers of the content editing view should register these renderers in the OnSetupGraphics(IGraphicsContext, GorgonSwapChain) method so that the renderers are available right away. Failure to do so can lead to broken rendering.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the `name`, or the `renderer` parameter is null.
ArgumentEmptyException	Thrown when the `name` parameter is empty.
ArgumentException	Thrown if a renderer is already registered with the same `name`.

Dispose(bool)

Clean up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	true if managed resources should be disposed; otherwise, false.

Overrides

ContentBaseControl.Dispose(bool)

| Edit this page View Source

HasRenderer(string)

Function to determine if a renderer with the specified name is registered.

Declaration

protected bool HasRenderer(string name)

Parameters

Type	Name	Description
string	name	The name of the renderer to evaluate.

Returns

Type	Description
bool	true if the renderer is registered, false if not.

| Edit this page View Source

OnAfterRender()

Function called after rendering ends.

Declaration

protected virtual void OnAfterRender()

Remarks

Developers can use this method to perform operations immediately after rendering the content.

| Edit this page View Source

OnBeforeRender()

Function called before rendering begins.

Declaration

protected virtual void OnBeforeRender()

Remarks

Developers can use this method to perform last minute updates prior to rendering the content.

| Edit this page View Source

OnLoad(EventArgs)

Raises the Load event.

Declaration

protected override void OnLoad(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e	An EventArgs that contains the event data.

Overrides

UserControl.OnLoad(EventArgs)

| Edit this page View Source

OnPropertyChanged(string)

Function called when a property is changed on the data context.

Declaration

protected override void OnPropertyChanged(string propertyName)

Parameters

Type	Name	Description
string	propertyName	The name of the property that is updated.

Overrides

ContentBaseControl.OnPropertyChanged(string)

Remarks

Implementors should override this method in order to handle a property change notification from their data context.

| Edit this page View Source

OnPropertyChanging(string)

Function called when a property is changing on the data context.

Declaration

protected override void OnPropertyChanging(string propertyName)

Parameters

Type	Name	Description
string	propertyName	The name of the property that is updating.

Overrides

ContentBaseControl.OnPropertyChanging(string)

Remarks

Implementors should override this method in order to handle a property change notification from their data context.

| Edit this page View Source

OnRenderWindowDragDrop(DragEventArgs)

Function to handle a drag drop event on the render control.

Declaration

protected virtual void OnRenderWindowDragDrop(DragEventArgs e)

Parameters

Type	Name	Description
DragEventArgs	e	The event arguments.

Remarks

Content editor developers can override this method to handle a drop event when an item is dropped into the rendering area on the view.

| Edit this page View Source

OnRenderWindowDragEnter(DragEventArgs)

Function to handle a drag enter event on the render control.

Declaration

protected virtual void OnRenderWindowDragEnter(DragEventArgs e)

Parameters

Type	Name	Description
DragEventArgs	e	The event arguments.

Remarks

Content editor developers can override this method to handle a drag enter event when an item is dragged into the rendering area on the view.

| Edit this page View Source

OnRenderWindowDragOver(DragEventArgs)

Function to handle a drag over event on the render control.

Declaration

protected virtual void OnRenderWindowDragOver(DragEventArgs e)

Parameters

Type	Name	Description
DragEventArgs	e	The event arguments.

Remarks

Content editor developers can override this method to handle a drag over event when an item is dragged over the rendering area on the view.

| Edit this page View Source

OnResize(EventArgs)

Raises the Resize event.

Declaration

protected override void OnResize(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e	An EventArgs that contains the event data.

Overrides

UserControl.OnResize(EventArgs)

| Edit this page View Source

OnSetDataContext(IVisualEditorContent)

Function to assign the data context to this object.

Declaration

protected void OnSetDataContext(IVisualEditorContent dataContext)

Parameters

Type	Name	Description
IVisualEditorContent	dataContext	The data context to assign.

Remarks

Applications must call this method when setting their own data context. Otherwise, some functionality will not work.

| Edit this page View Source

OnSetupContentRenderer(IGraphicsContext, GorgonSwapChain)

Function to allow applications to set up rendering for their specific use cases.

Declaration

protected virtual void OnSetupContentRenderer(IGraphicsContext context, GorgonSwapChain swapChain)

Parameters

Type	Name	Description
IGraphicsContext	context	The graphics context from the host application.
GorgonSwapChain	swapChain	The current swap chain for the rendering panel.

| Edit this page View Source

OnSetupGraphics(IGraphicsContext, GorgonSwapChain)

Function to allow user defined setup of the graphics context with this control.

Declaration

protected override sealed void OnSetupGraphics(IGraphicsContext context, GorgonSwapChain swapChain)

Parameters

Type	Name	Description
IGraphicsContext	context	The context being assigned.
GorgonSwapChain	swapChain	The swap chain assigned to the RenderControl.

Overrides

ContentBaseControl.OnSetupGraphics(IGraphicsContext, GorgonSwapChain)

| Edit this page View Source

OnShutdown()

Function called to shut down the view and perform any clean up required (including user defined graphics objects).

Declaration

protected override void OnShutdown()

Overrides

ContentBaseControl.OnShutdown()

| Edit this page View Source

OnSwitchRenderer(IContentRenderer, bool)

Function called when the renderer is switched.

Declaration

protected virtual void OnSwitchRenderer(IContentRenderer renderer, bool resetZoom)

Parameters

Type	Name	Description
IContentRenderer	renderer	The current renderer.
bool	resetZoom	true if the zoom should be reset, false if not.

| Edit this page View Source

SetupScrollBars()

Function to set up the scroll bars.

Declaration

protected void SetupScrollBars()

| Edit this page View Source

ShowCurrentPanel()

Function to show the current panel assigned to the CurrentPanel property.

Declaration

protected void ShowCurrentPanel()

| Edit this page View Source

SwitchRenderer(string, bool)

Function to switch to another registered renderer.

Declaration

protected void SwitchRenderer(string name, bool resetZoom)

Parameters

Type	Name	Description
string	name	The name of the renderer to switch to.
bool	resetZoom	true to reset the zoom back to the default, false to leave as-is.

Remarks

Developers will this method to switch between renderer types (if multiple renderers are used) to denote editor state.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the `name` parameter is null.
ArgumentEmptyException	Thrown when the `name` parameter is empty.
ArgumentException	Thrown if no renderer with the specified `name` was found.