Abstract class implementation of SpaceVIL.Core.IBaseItem interface. SpaceVIL.Core.IBaseItem is the main interface of SpaceVIL environment. Contains all the necessary methods for rendering objects and interacting with them. More...

Inherits SpaceVIL.Core.IBaseItem.

Inherited by SpaceVIL.Primitive.

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...

Prototype	GetParent ()
	Getting the parent of the item. More...

void	SetParent (Prototype parent)
	Setting the parent of the item. More...

virtual void	InitElements ()
	Initializing children if this BaseItem is container (SpaceVIL.Prototype). Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually. More...

Indents	GetMargin ()
	Getting the indents of an item to offset itself relative to its container. 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...

List< float[]>	GetTriangles ()
	Getting triangles of item's shape. More...

virtual void	SetTriangles (List< float[]> triangles)
	Setting triangles as item's shape. More...

virtual void	MakeShape ()
	Making default item's shape. Use in conjunction with GetTriangles() and SetTriangles() methods. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually. More...

virtual void	SetBackground (Color color)
	Setting background color of an item's shape. More...

virtual void	SetBackground (int r, int g, int b)
	Setting background color of an item's shape in byte RGB format. More...

virtual void	SetBackground (int r, int g, int b, int a)
	Setting background color of an item in byte RGBA format. More...

virtual void	SetBackground (float r, float g, float b)
	Setting background color of an item in float RGB format. More...

virtual void	SetBackground (float r, float g, float b, float a)
	Setting background color of an item in float RGBA format. More...

virtual Color	GetBackground ()
	Getting background color of an item. More...

void	SetItemName (string name)
	Setting the name of the item. More...

string	GetItemName ()
	Getting the name of the item. More...

virtual 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...

virtual 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...

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

virtual void	SetVisible (bool value)
	Setting the visibility status of an item. This property may used in conjunction with the IsDrawable() property. More...

void	SetMinWidth (int width)
	Setting the minimum width limit. Actual width cannot be less than this limit. More...

virtual void	SetWidth (int width)
	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)
	Setting the maximum width limit. Actual width cannot be greater than this limit. More...

int	GetMinWidth ()
	Getting the minimum width limit. More...

virtual int	GetWidth ()
	Getting item width. More...

int	GetMaxWidth ()
	Getting the maximum width limit. More...

void	SetMinHeight (int height)
	Setting the minimum height limit. Actual height cannot be less than this limit. More...

virtual void	SetHeight (int height)
	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)
	Setting the maximum height limit. Actual height cannot be greater than this limit. More...

int	GetMinHeight ()
	Getting the minimum height limit. More...

virtual int	GetHeight ()
	Getting item height. More...

int	GetMaxHeight ()
	Getting the maximum height limit. More...

void	SetSize (int width, int height)
	Setting item size (width and height). More...

void	SetMinSize (int width, int height)
	Setting minimum item size limit (width and height limits). More...

void	SetMaxSize (int width, int height)
	Setting maximum item size limit (width and height limits). More...

Core.Size	GetSize ()
	Getting current item size. More...

Core.Size	GetMinSize ()
	Getting current item minimum size limit. More...

Core.Size	GetMaxSize ()
	Getting current item maximum size limit. More...

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...

void	SetAlignment (params 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	SetSizePolicy (SizePolicy width, SizePolicy height)
	Setting the size 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	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...

virtual void	SetX (int x)
	Setting X coordinate of the left-top corner of a shape. More...

virtual int	GetX ()
	Getting X coordinate of the left-top corner of a shape. More...

virtual void	SetY (int y)
	Setting Y coordinate of the left-top corner of a shape. More...

virtual int	GetY ()
	Getting Y coordinate of the left-top corner of a shape. More...

void	Update (GeometryEventType type, int value=0)
	Updating an item size or/and position. More...

virtual void	SetStyle (Style style)
	Setting a style that describes the appearance of an item. More...

abstract Style	GetCoreStyle ()
	Getting the core (only appearance properties without inner styles) style of an item. 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	SetShadowExtension (int wExtension, int hExtension)
	Setting 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	SetShadow (Shadow shadow)
	Setting the shadow of an item. More...

virtual 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...

virtual void	Release ()
	Method to describe disposing item's resources if the item was removed. More...

Public Attributes
ItemHoverRule	HoverRule = ItemHoverRule.Lazy
	Hovering rule propetry of this item. Can be ItemHoverRule.Lazy or ItemHoverRule.Strict (see SpaceVIL.Core.ItemHoverRule). More...

Detailed Description

Abstract class implementation of SpaceVIL.Core.IBaseItem interface.

SpaceVIL.Core.IBaseItem is the main interface of SpaceVIL environment.

Contains all the necessary methods for rendering objects and interacting with them.

Member Function Documentation

◆ GetAlignment()

ItemAlignment SpaceVIL.BaseItem.GetAlignment ( )

Getting an alignment of an item's shape relative to its container.

Returns: Alignment as SpaceVIL.Core.ItemAlignment.

Implements SpaceVIL.Core.IBehavior.

◆ GetBackground()

virtual Color SpaceVIL.BaseItem.GetBackground ( )

virtual

Getting background color of an item.

Returns: Background color as System.Drawing.Color.

Implements SpaceVIL.Core.IItem.

◆ GetCoreStyle()

abstract Style SpaceVIL.BaseItem.GetCoreStyle ( )

pure virtual

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

Returns: Style as SpaceVIL.Decorations.Style.

Implements SpaceVIL.Core.IBaseItem.

Implemented in SpaceVIL.Primitive.

◆ GetHandler()

CoreWindow SpaceVIL.BaseItem.GetHandler ( )

Getting the window to which the item will belong.

Returns: Window as SpaceVIL.CoreWindow.

Implements SpaceVIL.Core.IBaseItem.

◆ GetHeight()

virtual int SpaceVIL.BaseItem.GetHeight ( )

virtual

Getting item height.

Returns: Height of the item.

Implements SpaceVIL.Core.ISize.

◆ GetHeightPolicy()

SizePolicy SpaceVIL.BaseItem.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).

Returns: Height policy as SpaceVIL.Core.SizePolicy.

Implements SpaceVIL.Core.IBehavior.

◆ GetItemName()

string SpaceVIL.BaseItem.GetItemName ( )

Getting the name of the item.

Returns: Item name as System.String.

Implements SpaceVIL.Core.IItem.

◆ GetMargin()

Indents SpaceVIL.BaseItem.GetMargin ( )

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

Returns: Margin as SpaceVIL.Decorations.Indents.

Implements SpaceVIL.Core.IBaseItem.

◆ GetMaxHeight()

int SpaceVIL.BaseItem.GetMaxHeight ( )

Getting the maximum height limit.

Returns: Maximum height limit of the item.

Implements SpaceVIL.Core.ISize.

◆ GetMaxSize()

Core.Size SpaceVIL.BaseItem.GetMaxSize ( )

Getting current item maximum size limit.

Returns: Minimum item size limit as SpaceVIL.Core.Size.

◆ GetMaxWidth()

int SpaceVIL.BaseItem.GetMaxWidth ( )

Getting the maximum width limit.

Returns: Maximum width limit of the item.

Implements SpaceVIL.Core.ISize.

◆ GetMinHeight()

int SpaceVIL.BaseItem.GetMinHeight ( )

Getting the minimum height limit.

Returns: Minimum height limit of the item.

Implements SpaceVIL.Core.ISize.

◆ GetMinSize()

Core.Size SpaceVIL.BaseItem.GetMinSize ( )

Getting current item minimum size limit.

Returns: Minimum item size limit as SpaceVIL.Core.Size.

◆ GetMinWidth()

int SpaceVIL.BaseItem.GetMinWidth ( )

Getting the minimum width limit.

Returns: Minimum width limit of the item.

Implements SpaceVIL.Core.ISize.

◆ GetParent()

Prototype SpaceVIL.BaseItem.GetParent ( )

Getting the parent of the item.

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

Implements SpaceVIL.Core.IBaseItem.

◆ GetShadowColor()

Color SpaceVIL.BaseItem.GetShadowColor ( )

Getting shadow color.

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

Implements SpaceVIL.Core.IBaseItem.

◆ GetShadowExtension()

int [] SpaceVIL.BaseItem.GetShadowExtension ( )

Getting the values of shadow extensions in pixels.

Returns: The values of shadow extensions. 0 - width extension, 1 - height extension.

Implements SpaceVIL.Core.IBaseItem.

◆ GetShadowPos()

Position SpaceVIL.BaseItem.GetShadowPos ( )

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

Returns: Shadow offset as SpaceVIL.Core.Position.

Implements SpaceVIL.Core.IBaseItem.

◆ GetShadowRadius()

int SpaceVIL.BaseItem.GetShadowRadius ( )

Getting the shadow blur raduis.

Returns: The blur radius of the shadow.

Implements SpaceVIL.Core.IBaseItem.

◆ GetSize()

Core.Size SpaceVIL.BaseItem.GetSize ( )

Getting current item size.

Returns: Item size as SpaceVIL.Core.Size.

Implements SpaceVIL.Core.ISize.

◆ GetTriangles()

List<float[]> SpaceVIL.BaseItem.GetTriangles ( )

Getting triangles of item's shape.

Returns: Points list of the shape as List of float[2] array (2D).

Implements SpaceVIL.Core.IItem.

◆ GetWidth()

virtual int SpaceVIL.BaseItem.GetWidth ( )

virtual

Getting item width.

Returns: Width of the item.

Implements SpaceVIL.Core.ISize.

◆ GetWidthPolicy()

SizePolicy SpaceVIL.BaseItem.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).

Returns: Width policy as SpaceVIL.Core.SizePolicy.

Implements SpaceVIL.Core.IBehavior.

◆ GetX()

virtual int SpaceVIL.BaseItem.GetX ( )

virtual

Getting X coordinate of the left-top corner of a shape.

Returns: X position of the left-top corner.

Implements SpaceVIL.Core.IPosition.

◆ GetY()

virtual int SpaceVIL.BaseItem.GetY ( )

virtual

Getting Y coordinate of the left-top corner of a shape.

Returns: Y position of the left-top corner.

Implements SpaceVIL.Core.IPosition.

◆ InitElements()

virtual void SpaceVIL.BaseItem.InitElements ( )

virtual

Initializing children if this BaseItem is container (SpaceVIL.Prototype). Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually.

Implements SpaceVIL.Core.IBaseItem.

◆ IsDrawable()

virtual bool SpaceVIL.BaseItem.IsDrawable ( )

virtual

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).

Implements SpaceVIL.Core.IBaseItem.

◆ IsShadowDrop()

bool SpaceVIL.BaseItem.IsShadowDrop ( )

Getting the shadow visibility status of an item.

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

Implements SpaceVIL.Core.IBaseItem.

◆ IsVisible()

virtual bool SpaceVIL.BaseItem.IsVisible ( )

virtual

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.

Implements SpaceVIL.Core.IBaseItem.

◆ MakeShape()

virtual void SpaceVIL.BaseItem.MakeShape ( )

virtual

Making default item's shape. Use in conjunction with GetTriangles() and SetTriangles() methods. Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually.

Implements SpaceVIL.Core.IItem.

Reimplemented in SpaceVIL.PointsContainer, SpaceVIL.LinesContainer, SpaceVIL.Rectangle, SpaceVIL.Triangle, SpaceVIL.CustomShape, and SpaceVIL.Ellipse.

◆ Release()

virtual void SpaceVIL.BaseItem.Release ( )

virtual

Method to describe disposing item's resources if the item was removed.

Implements SpaceVIL.Core.IBaseItem.

◆ SetAlignment() [1/2]

void SpaceVIL.BaseItem.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).

Parameters

alignment Alignment as SpaceVIL.Core.ItemAlignment.

Implements SpaceVIL.Core.IBehavior.

◆ SetAlignment() [2/2]

void SpaceVIL.BaseItem.SetAlignment ( params 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).

Parameters

alignment Alignment as sequence of SpaceVIL.Core.ItemAlignment.

◆ SetBackground() [1/5]

virtual void SpaceVIL.BaseItem.SetBackground ( Color color )

virtual

Setting background color of an item's shape.

Parameters

color Background color as System.Drawing.Color.

Implements SpaceVIL.Core.IItem.

◆ SetBackground() [2/5]

virtual void SpaceVIL.BaseItem.SetBackground	(	float	r,
		float	g,
		float	b
	)

virtual

Setting background color of an item in float RGB format.

Parameters

r	Red color component. Range: (0.0f - 1.0f)
g	Green color component. Range: (0.0f - 1.0f)
b	Blue color component. Range: (0.0f - 1.0f)

◆ SetBackground() [3/5]

virtual void SpaceVIL.BaseItem.SetBackground	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Setting background color of an item in float RGBA format.

Parameters

r	Red color component. Range: (0.0f - 1.0f)
g	Green color component. Range: (0.0f - 1.0f)
b	Blue color component. Range: (0.0f - 1.0f)
a	Alpha color component. Range: (0.0f - 1.0f)

◆ SetBackground() [4/5]

virtual void SpaceVIL.BaseItem.SetBackground	(	int	r,
		int	g,
		int	b
	)

virtual

Setting background color of an item's shape in byte RGB format.

Parameters

r	Red color component. Range: (0 - 255)
g	Green color component. Range: (0 - 255)
b	Blue color component. Range: (0 - 255)

◆ SetBackground() [5/5]

virtual void SpaceVIL.BaseItem.SetBackground	(	int	r,
		int	g,
		int	b,
		int	a
	)

virtual

Setting background color of an item in byte RGBA format.

Parameters

r	Red color component. Range: (0 - 255)
g	Green color component. Range: (0 - 255)
b	Blue color component. Range: (0 - 255)
a	Alpha color component. Range: (0 - 255)

◆ SetConfines() [1/2]

virtual void SpaceVIL.BaseItem.SetConfines ( )

virtual

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.

Implements SpaceVIL.Core.IBaseItem.

◆ SetConfines() [2/2]

void SpaceVIL.BaseItem.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

x0	Left X begin position.
x1	Right X end position.
y0	Top Y begin position.
y1	Bottom Y end position.

Implements SpaceVIL.Core.IBaseItem.

◆ SetDrawable()

virtual void SpaceVIL.BaseItem.SetDrawable ( bool value )

virtual

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

value True: if item should be drawable (visible). False: if item should not be drawable (invisible).

Implements SpaceVIL.Core.IBaseItem.

◆ SetHandler()

void SpaceVIL.BaseItem.SetHandler ( CoreWindow handler )

Setting the window to which the item will belong.

Parameters

handler Window as SpaceVIL.CoreWindow.

Implements SpaceVIL.Core.IBaseItem.

◆ SetHeight()

virtual void SpaceVIL.BaseItem.SetHeight ( int height )

virtual

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.

Parameters

height Height of the item.

Implements SpaceVIL.Core.ISize.

◆ SetHeightPolicy()

void SpaceVIL.BaseItem.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).

Parameters

policy Height policy as SpaceVIL.Core.SizePolicy.

Implements SpaceVIL.Core.IBehavior.

◆ SetItemName()

void SpaceVIL.BaseItem.SetItemName ( string name )

Setting the name of the item.

Parameters

name	Item name as System.String.

Implements SpaceVIL.Core.IItem.

◆ SetMargin() [1/2]

void SpaceVIL.BaseItem.SetMargin ( Indents margin )

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

Parameters

margin Margin as SpaceVIL.Decorations.Indents.

Implements SpaceVIL.Core.IBaseItem.

◆ SetMargin() [2/2]

void SpaceVIL.BaseItem.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

left	Indent on the left.
top	Indent on the top.
right	Indent on the right.
bottom	Indent on the bottom.

Implements SpaceVIL.Core.IBaseItem.

◆ SetMaxHeight()

void SpaceVIL.BaseItem.SetMaxHeight ( int height )

Setting the maximum height limit. Actual height cannot be greater than this limit.

Parameters

height Maximum height limit of the item.

Implements SpaceVIL.Core.ISize.

◆ SetMaxSize()

void SpaceVIL.BaseItem.SetMaxSize	(	int	width,
		int	height
	)

Setting maximum item size limit (width and height limits).

Parameters

width	Maximum width limit of the item.
height	Maximum height limit of the item.

◆ SetMaxWidth()

void SpaceVIL.BaseItem.SetMaxWidth ( int width )

Setting the maximum width limit. Actual width cannot be greater than this limit.

Parameters

width Maximum width limit of the item.

Implements SpaceVIL.Core.ISize.

◆ SetMinHeight()

void SpaceVIL.BaseItem.SetMinHeight ( int height )

Setting the minimum height limit. Actual height cannot be less than this limit.

Parameters

height Minimum height limit of the item.

Implements SpaceVIL.Core.ISize.

◆ SetMinSize()

void SpaceVIL.BaseItem.SetMinSize	(	int	width,
		int	height
	)

Setting minimum item size limit (width and height limits).

Parameters

width	Minimum width limit of the item.
height	Minimum height limit of the item.

◆ SetMinWidth()

void SpaceVIL.BaseItem.SetMinWidth ( int width )

Setting the minimum width limit. Actual width cannot be less than this limit.

Parameters

width Minimum width limit of the item.

Implements SpaceVIL.Core.ISize.

◆ SetParent()

void SpaceVIL.BaseItem.SetParent ( Prototype parent )

Setting the parent of the item.

Parameters

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

Implements SpaceVIL.Core.IBaseItem.

◆ SetShadow() [1/2]

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

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

Parameters

radius	A blur radius of the shadow.
x	X shift of the shadow.
y	Y shift of the shadow.
color	A shadow color as System.Drawing.Color.

Implements SpaceVIL.Core.IBaseItem.

◆ SetShadow() [2/2]

void SpaceVIL.BaseItem.SetShadow ( Shadow shadow )

Setting the shadow of an item.

Parameters

shadow Shadow as SpaceVIL.Decorations.Shadow.

◆ SetShadowColor()

void SpaceVIL.BaseItem.SetShadowColor ( Color color )

Setting shadow color.

Parameters

color Shadow color as System.Drawing.Color.

Implements SpaceVIL.Core.IBaseItem.

◆ SetShadowDrop()

void SpaceVIL.BaseItem.SetShadowDrop ( bool value )

Setting the shadow visibility status of an item.

Parameters

value True: if shadow should be visible. False: if shadow should be invisible.

Implements SpaceVIL.Core.IBaseItem.

◆ SetShadowExtension()

void SpaceVIL.BaseItem.SetShadowExtension	(	int	wExtension,
		int	hExtension
	)

Setting the values of shadow extensions in pixels.

Parameters

wExtension	Extension by width.
hExtension	Extension by height.

◆ SetShadowRadius()

void SpaceVIL.BaseItem.SetShadowRadius ( int radius )

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

Parameters

radius The blur radius of the shadow.

Implements SpaceVIL.Core.IBaseItem.

◆ SetSize()

void SpaceVIL.BaseItem.SetSize	(	int	width,
		int	height
	)

Setting item size (width and height).

Parameters

width	Width of the item.
height	Height of the item.

Implements SpaceVIL.Core.ISize.

◆ SetSizePolicy()

void SpaceVIL.BaseItem.SetSizePolicy	(	SizePolicy	width,
		SizePolicy	height
	)

Setting the size policy of an item's shape. Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space).

Parameters

width	Width policy of an item's shape as SpaceVIL.Core.SizePolicy.
height	Height policy of an item's shape as SpaceVIL.Core.SizePolicy.

◆ SetStyle()

virtual void SpaceVIL.BaseItem.SetStyle ( Style style )

virtual

Setting a style that describes the appearance of an item.

Parameters

style Style as SpaceVIL.Decorations.Style.

Implements SpaceVIL.Core.IBaseItem.

Reimplemented in SpaceVIL.Primitive.

◆ SetTriangles()

virtual void SpaceVIL.BaseItem.SetTriangles ( List< float[]> triangles )

virtual

Setting triangles as item's shape.

Parameters

triangles Points list of the shape as List of float[2] array (2D).

Implements SpaceVIL.Core.IItem.

◆ SetVisible()

virtual void SpaceVIL.BaseItem.SetVisible ( bool value )

virtual

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

Parameters

value True: if item should be visible. False: if item should be invisible.

Implements SpaceVIL.Core.IBaseItem.

◆ SetWidth()

virtual void SpaceVIL.BaseItem.SetWidth ( int width )

virtual

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.

Parameters

width Width of the item.

Implements SpaceVIL.Core.ISize.

◆ SetWidthPolicy()

void SpaceVIL.BaseItem.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).

Parameters

policy Width policy as SpaceVIL.Core.SizePolicy.

Implements SpaceVIL.Core.IBehavior.

◆ SetX()

virtual void SpaceVIL.BaseItem.SetX ( int x )

virtual

Setting X coordinate of the left-top corner of a shape.

Parameters

x	X position of the left-top corner.

Implements SpaceVIL.Core.IPosition.

◆ SetY()

virtual void SpaceVIL.BaseItem.SetY ( int y )

virtual

Setting Y coordinate of the left-top corner of a shape.

Parameters

y	Y position of the left-top corner.

Implements SpaceVIL.Core.IPosition.

◆ Update()

void SpaceVIL.BaseItem.Update	(	GeometryEventType	type,
		int	value = `0`
	)

Updating an item size or/and position.

Parameters

type	Type of event as SpaceVIL.Core.GeometryEventType.
value	Value of a property that was changed.

Implements SpaceVIL.Core.IEventUpdate.

Member Data Documentation

◆ HoverRule

ItemHoverRule SpaceVIL.BaseItem.HoverRule = ItemHoverRule.Lazy

Hovering rule propetry of this item. Can be ItemHoverRule.Lazy or ItemHoverRule.Strict (see SpaceVIL.Core.ItemHoverRule).

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

BaseItem.cs

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ GetAlignment()

◆ GetBackground()

◆ GetCoreStyle()

◆ GetHandler()

◆ GetHeight()

◆ GetHeightPolicy()

◆ GetItemName()

◆ GetMargin()

◆ GetMaxHeight()

◆ GetMaxSize()

◆ GetMaxWidth()

◆ GetMinHeight()

◆ GetMinSize()

◆ GetMinWidth()

◆ GetParent()

◆ GetShadowColor()

◆ GetShadowExtension()

◆ GetShadowPos()

◆ GetShadowRadius()

◆ GetSize()

◆ GetTriangles()

◆ GetWidth()

◆ GetWidthPolicy()

◆ GetX()

◆ GetY()

◆ InitElements()

◆ IsDrawable()

◆ IsShadowDrop()

◆ IsVisible()

◆ MakeShape()

◆ Release()

◆ SetAlignment() [1/2]

◆ SetAlignment() [2/2]

◆ SetBackground() [1/5]

◆ SetBackground() [2/5]

◆ SetBackground() [3/5]

◆ SetBackground() [4/5]

◆ SetBackground() [5/5]

◆ SetConfines() [1/2]

◆ SetConfines() [2/2]

◆ SetDrawable()

◆ SetHandler()

◆ SetHeight()

◆ SetHeightPolicy()

◆ SetItemName()

◆ SetMargin() [1/2]

◆ SetMargin() [2/2]

◆ SetMaxHeight()

◆ SetMaxSize()

◆ SetMaxWidth()

◆ SetMinHeight()

◆ SetMinSize()

◆ SetMinWidth()

◆ SetParent()

◆ SetShadow() [1/2]

◆ SetShadow() [2/2]

◆ SetShadowColor()

◆ SetShadowDrop()

◆ SetShadowExtension()

◆ SetShadowRadius()

◆ SetSize()

◆ SetSizePolicy()

◆ SetStyle()

◆ SetTriangles()

◆ SetVisible()

◆ SetWidth()

◆ SetWidthPolicy()

◆ SetX()

◆ SetY()

◆ Update()

Member Data Documentation

◆ HoverRule