Reference for .Net version of SpaceVIL  0.3.5.8
SpaceVIL (Space of Visual Items Layout) is a cross-platform and multilingual framework for creating GUI client applications for .NET Standard, .NET Core and JVM. SpaceVIL is based on OpenGL graphic technology and GLFW. Using this framework in conjunction with .Net Core or with a JVM, you can work and create graphical client applications on Linux, Mac OS X and Windows.
SpaceVIL.Core.IBaseItem Interface Reference

The main interface of SpaceVIL environment. Contains all the necessary methods for rendering objects and interacting with them. Implementations: BaseItem, Prototype, Primitive. More...

Inherits SpaceVIL.Core.IItem, SpaceVIL.Core.ISize, SpaceVIL.Core.IPosition, SpaceVIL.Core.IEventUpdate, and SpaceVIL.Core.IBehavior.

Inherited by SpaceVIL.BaseItem, and SpaceVIL.Prototype.

Public Member Functions

void SetHandler (CoreWindow handler)
 Setting the window to which the item will belong. More...
 
CoreWindow GetHandler ()
 Getting the window to which the item will belong. More...
 
void SetParent (Prototype parent)
 Setting the parent of the item. More...
 
Prototype GetParent ()
 Getting the parent of the item. More...
 
void SetConfines ()
 Setting the confines of the item relative to its parent's size and position. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user. More...
 
void SetConfines (int x0, int x1, int y0, int y1)
 Setting the confines of the item relative to specified bounds. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user. More...
 
void SetMargin (Indents margin)
 Setting the indents of an item to offset itself relative to its container. More...
 
void SetMargin (int left=0, int top=0, int right=0, int bottom=0)
 Setting the indents of an item to offset itself relative to its container. More...
 
Indents GetMargin ()
 Getting the indents of an item to offset itself relative to its container. More...
 
void InitElements ()
 Initializing children if this IBaseItem is container (SpaceVIL.Prototype). More...
 
void SetStyle (Style style)
 Setting a style that describes the appearance of an item. More...
 
Style GetCoreStyle ()
 Getting the core (only appearance properties without inner styles) style of an item. More...
 
bool IsDrawable ()
 Getting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView). More...
 
void SetDrawable (bool value)
 Setting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView). More...
 
bool IsVisible ()
 Getting the visibility status of an item. This property may used in conjunction with the IsDrawable() property. More...
 
void SetVisible (bool value)
 Setting the visibility status of an item. This property may used in conjunction with the IsDrawable() property. More...
 
bool IsShadowDrop ()
 Getting the shadow visibility status of an item. More...
 
void SetShadowDrop (bool value)
 Setting the shadow visibility status of an item. More...
 
void SetShadowRadius (int radius)
 Setting the specified blur radius of the shadow. Default: 0. More...
 
int GetShadowRadius ()
 Getting the shadow blur raduis. More...
 
Color GetShadowColor ()
 Getting shadow color. More...
 
void SetShadowColor (Color color)
 Setting shadow color. More...
 
Position GetShadowPos ()
 Getting the offset of the shadow relative to the position of the item. More...
 
int[] GetShadowExtension ()
 Getting the values of shadow extensions in pixels. More...
 
void SetShadow (int radius, int x, int y, Color color)
 Setting the shadow with specified blur radius, axis shifts, shadow color. More...
 
void Release ()
 Method to describe disposing item's resources if the item was removed. More...
 
- Public Member Functions inherited from SpaceVIL.Core.IItem
void SetItemName (string name)
 Method for setting the name of the item. More...
 
string GetItemName ()
 Method for getting the name of the item. More...
 
void SetBackground (Color color)
 Method for setting background color. More...
 
Color GetBackground ()
 Method for getting background color. More...
 
List< float[]> GetTriangles ()
 Method for getting triangles of item's shape. More...
 
void SetTriangles (List< float[]> triangles)
 Method for setting triangles as item's shape. More...
 
void MakeShape ()
 Method for making default item's shape. Use in conjunction with GetTriangles() and SetTriangles() methods. More...
 
- Public Member Functions inherited from SpaceVIL.Core.ISize
void SetSize (int width, int height)
 Method setting size of an item's shape. More...
 
Size GetSize ()
 Method getting size of an item's shape. More...
 
void SetMinWidth (int width)
 Method setting the minimum width limit. Actual width cannot be less than this limit. More...
 
void SetWidth (int width)
 Method setting item width. If the value is greater/less than the maximum/minimum value of the width, then the width becomes equal to the maximum/minimum value. More...
 
void SetMaxWidth (int width)
 Method setting the maximum width limit. Actual width cannot be greater than this limit. More...
 
int GetMinWidth ()
 Method getting the minimum width limit. More...
 
int GetWidth ()
 Method fetting item width. More...
 
int GetMaxWidth ()
 Method getting the maximum width limit. More...
 
void SetMinHeight (int height)
 Method for setting the minimum height limit. Actual height cannot be less than this limit. More...
 
void SetHeight (int height)
 Method for setting item height. If the value is greater/less than the maximum/minimum value of the height, then the height becomes equal to the maximum/minimum value. More...
 
void SetMaxHeight (int height)
 Method for setting the maximum height limit. Actual height cannot be greater than this limit. More...
 
int GetMinHeight ()
 Method for getting the minimum height limit. More...
 
int GetHeight ()
 Method for getting item height. More...
 
int GetMaxHeight ()
 Method for getting the maximum height limit. More...
 
- Public Member Functions inherited from SpaceVIL.Core.IPosition
void SetX (int x)
 Method for setting X coordinate of the left-top corner of a shape. More...
 
int GetX ()
 Method for getting X coordinate of the left-top corner of a shape. More...
 
void SetY (int y)
 Method for setting Y coordinate of the left-top corner of a shape. More...
 
int GetY ()
 Method for getting Y coordinate of the left-top corner of a shape. More...
 
- Public Member Functions inherited from SpaceVIL.Core.IEventUpdate
void Update (GeometryEventType type, int value)
 Method for updating an item size or/and position. More...
 
- Public Member Functions inherited from SpaceVIL.Core.IBehavior
void SetAlignment (ItemAlignment alignment)
 Setting an alignment of an item's shape relative to its container. Combines with alignment by vertically (Top, VCenter, Bottom) and horizontally (Left, HCenter, Right). More...
 
ItemAlignment GetAlignment ()
 Getting an alignment of an item's shape relative to its container. More...
 
void SetWidthPolicy (SizePolicy policy)
 Setting width policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
SizePolicy GetWidthPolicy ()
 Getting width policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
void SetHeightPolicy (SizePolicy policy)
 Setting height policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 
SizePolicy GetHeightPolicy ()
 Getting height policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...
 

Detailed Description

The main interface of SpaceVIL environment. Contains all the necessary methods for rendering objects and interacting with them.

Implementations: BaseItem, Prototype, Primitive.

Member Function Documentation

◆ GetCoreStyle()

Style SpaceVIL.Core.IBaseItem.GetCoreStyle ( )

Getting the core (only appearance properties without inner styles) style of an item.

Returns
Style as SpaceVIL.Decorations.Style.

Implemented in SpaceVIL.Prototype, SpaceVIL.BaseItem, and SpaceVIL.Primitive.

◆ GetHandler()

CoreWindow SpaceVIL.Core.IBaseItem.GetHandler ( )

Getting the window to which the item will belong.

Returns
Window as SpaceVIL.CoreWindow.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ GetMargin()

Indents SpaceVIL.Core.IBaseItem.GetMargin ( )

Getting the indents of an item to offset itself relative to its container.

Returns
Margin as SpaceVIL.Decorations.Indents.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ GetParent()

Prototype SpaceVIL.Core.IBaseItem.GetParent ( )

Getting the parent of the item.

Returns
Parent as SpaceVIL.Prototype (Prototype is container and can contains children).

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ GetShadowColor()

Color SpaceVIL.Core.IBaseItem.GetShadowColor ( )

Getting shadow color.

Returns
Returns the shadow color as System.Drawing.Color.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ GetShadowExtension()

int [] SpaceVIL.Core.IBaseItem.GetShadowExtension ( )

Getting the values of shadow extensions in pixels.

Returns
The values of shadow extensions.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ GetShadowPos()

Position SpaceVIL.Core.IBaseItem.GetShadowPos ( )

Getting the offset of the shadow relative to the position of the item.

Returns
Shadow offset as SpaceVIL.Core.Position.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ GetShadowRadius()

int SpaceVIL.Core.IBaseItem.GetShadowRadius ( )

Getting the shadow blur raduis.

Returns
The blur radius of the shadow.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ InitElements()

◆ IsDrawable()

bool SpaceVIL.Core.IBaseItem.IsDrawable ( )

Getting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView).

Returns
True: if item is drawable (visible). False: if item is not drawable (invisible).

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ IsShadowDrop()

bool SpaceVIL.Core.IBaseItem.IsShadowDrop ( )

Getting the shadow visibility status of an item.

Returns
True: if shadow is visible. False: if shadow is invisible.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ IsVisible()

bool SpaceVIL.Core.IBaseItem.IsVisible ( )

Getting the visibility status of an item. This property may used in conjunction with the IsDrawable() property.

Returns
True: if item is visible. False: if item is invisible.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ Release()

◆ SetConfines() [1/2]

void SpaceVIL.Core.IBaseItem.SetConfines ( )

Setting the confines of the item relative to its parent's size and position. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user.

Implemented in SpaceVIL.BaseItem, SpaceVIL.Prototype, SpaceVIL.ComboBoxDropDown, SpaceVIL.ContextMenu, and SpaceVIL.FloatItem.

◆ SetConfines() [2/2]

void SpaceVIL.Core.IBaseItem.SetConfines ( int  x0,
int  x1,
int  y0,
int  y1 
)

Setting the confines of the item relative to specified bounds. Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user.

Parameters
x0Left X begin position.
x1Right X end position.
y0Top Y begin position.
y1Bottom Y end position.

Implemented in SpaceVIL.BaseItem, and SpaceVIL.Prototype.

◆ SetDrawable()

void SpaceVIL.Core.IBaseItem.SetDrawable ( bool  value)

Setting the drawable (visibility) status of an item. This property used in conjunction with the IsVisible() property. Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: SpaceVIL.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: SpaceVIL.TreeView).

Parameters
valueTrue: if item should be drawable (visible). False: if item should not be drawable (invisible).

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ SetHandler()

void SpaceVIL.Core.IBaseItem.SetHandler ( CoreWindow  handler)

Setting the window to which the item will belong.

Parameters
handlerWindow as SpaceVIL.CoreWindow.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ SetMargin() [1/2]

void SpaceVIL.Core.IBaseItem.SetMargin ( Indents  margin)

Setting the indents of an item to offset itself relative to its container.

Parameters
marginMargin as SpaceVIL.Decorations.Indents.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ SetMargin() [2/2]

void SpaceVIL.Core.IBaseItem.SetMargin ( int  left = 0,
int  top = 0,
int  right = 0,
int  bottom = 0 
)

Setting the indents of an item to offset itself relative to its container.

Parameters
leftIndent on the left.
topIndent on the top.
rightIndent on the right.
bottomIndent on the bottom.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ SetParent()

void SpaceVIL.Core.IBaseItem.SetParent ( Prototype  parent)

Setting the parent of the item.

Parameters
parentParent as SpaceVIL.Prototype (Prototype is container and can contains children).

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ SetShadow()

void SpaceVIL.Core.IBaseItem.SetShadow ( int  radius,
int  x,
int  y,
Color  color 
)

Setting the shadow with specified blur radius, axis shifts, shadow color.

Parameters
radiusA blur radius of the shadow.
xX shift of the shadow.
yY shift of the shadow.
colorA shadow color as System.Drawing.Color.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ SetShadowColor()

void SpaceVIL.Core.IBaseItem.SetShadowColor ( Color  color)

Setting shadow color.

Parameters
colorShadow color as System.Drawing.Color.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ SetShadowDrop()

void SpaceVIL.Core.IBaseItem.SetShadowDrop ( bool  value)

Setting the shadow visibility status of an item.

Parameters
valueTrue: if shadow should be visible. False: if shadow should be invisible.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ SetShadowRadius()

void SpaceVIL.Core.IBaseItem.SetShadowRadius ( int  radius)

Setting the specified blur radius of the shadow. Default: 0.

Parameters
radiusBlur radius of the shadow.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.

◆ SetStyle()

◆ SetVisible()

void SpaceVIL.Core.IBaseItem.SetVisible ( bool  value)

Setting the visibility status of an item. This property may used in conjunction with the IsDrawable() property.

Parameters
valueTrue: if item should be visible. False: if item should be invisible.

Implemented in SpaceVIL.Prototype, and SpaceVIL.BaseItem.


The documentation for this interface was generated from the following file: