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.Decorations.SubtractFigure Class Reference

SubtractFigure is visual effect for applying to item's shape. Implements SpaceVIL.Core.ISubtractFigure and SpaceVIL.Core.IEffect. This visual effect cuts specified shape from original item's shape. More...

Inherits SpaceVIL.Core.ISubtractFigure, and SpaceVIL.Core.IEffect.

Public Member Functions

 SubtractFigure (Figure figure)
 Constructs subtract effect with specified shape. More...
 
void SetSubtractFigure (Figure figure)
 Setting shape for subtraction. More...
 
Figure GetSubtractFigure ()
 Getting the current figure for subtraction. More...
 
string GetEffectName ()
 Getting the effect name. More...
 
void SetPositionOffset (int x, int y)
 Setting shape's shift by X, Y axis. More...
 
void SetSizeScale (float wScale, float hScale)
 Setting shape's scaling factors for width and height. More...
 
int GetXOffset ()
 Getting shape's shift by X-axis. More...
 
int GetYOffset ()
 Getting shape's shift by Y-axis. More...
 
float GetWidthScale ()
 Getting width scaling. More...
 
float GetHeightScale ()
 Getting height scaling. More...
 
ItemAlignment GetAlignment ()
 Getting shape's allignment within the item. More...
 
void SetAlignment (params ItemAlignment[] alignments)
 Setting shape's allignment within the item. More...
 

Detailed Description

SubtractFigure is visual effect for applying to item's shape. Implements SpaceVIL.Core.ISubtractFigure and SpaceVIL.Core.IEffect.

This visual effect cuts specified shape from original item's shape.

Constructor & Destructor Documentation

◆ SubtractFigure()

SpaceVIL.Decorations.SubtractFigure.SubtractFigure ( Figure  figure)

Constructs subtract effect with specified shape.

Parameters
figureFigure for subtraction as SpaceVIL.Decoratons.Figure.

Member Function Documentation

◆ GetAlignment()

ItemAlignment SpaceVIL.Decorations.SubtractFigure.GetAlignment ( )

Getting shape's allignment within the item.

Returns
Alignment as SpaceVIL.Core.ItemAlignment.

Implements SpaceVIL.Core.ISubtractFigure.

◆ GetEffectName()

string SpaceVIL.Decorations.SubtractFigure.GetEffectName ( )

Getting the effect name.

Returns
Returns name SubtractEffect as System.String.

Implements SpaceVIL.Core.IEffect.

◆ GetHeightScale()

float SpaceVIL.Decorations.SubtractFigure.GetHeightScale ( )

Getting height scaling.

Returns
Height scaling.

Implements SpaceVIL.Core.ISubtractFigure.

◆ GetSubtractFigure()

Figure SpaceVIL.Decorations.SubtractFigure.GetSubtractFigure ( )

Getting the current figure for subtraction.

Returns
Figure for subtraction as SpaceVIL.Decoratons.Figure.

Implements SpaceVIL.Core.ISubtractFigure.

◆ GetWidthScale()

float SpaceVIL.Decorations.SubtractFigure.GetWidthScale ( )

Getting width scaling.

Returns
Width scaling.

Implements SpaceVIL.Core.ISubtractFigure.

◆ GetXOffset()

int SpaceVIL.Decorations.SubtractFigure.GetXOffset ( )

Getting shape's shift by X-axis.

Returns
X axis shift.

Implements SpaceVIL.Core.ISubtractFigure.

◆ GetYOffset()

int SpaceVIL.Decorations.SubtractFigure.GetYOffset ( )

Getting shape's shift by Y-axis.

Returns
Y axis shift.

Implements SpaceVIL.Core.ISubtractFigure.

◆ SetAlignment()

void SpaceVIL.Decorations.SubtractFigure.SetAlignment ( params ItemAlignment[]  alignments)

Setting shape's allignment within the item.

Parameters
alignmentsAlignment as SpaceVIL.Core.ItemAlignment.

Implements SpaceVIL.Core.ISubtractFigure.

◆ SetPositionOffset()

void SpaceVIL.Decorations.SubtractFigure.SetPositionOffset ( int  x,
int  y 
)

Setting shape's shift by X, Y axis.

Parameters
xX axis shift.
yY axis shift.

Implements SpaceVIL.Core.ISubtractFigure.

◆ SetSizeScale()

void SpaceVIL.Decorations.SubtractFigure.SetSizeScale ( float  wScale,
float  hScale 
)

Setting shape's scaling factors for width and height.

Parameters
wScaleScaling factor for width.
hScaleScaling factor for height.

Implements SpaceVIL.Core.ISubtractFigure.

◆ SetSubtractFigure()

void SpaceVIL.Decorations.SubtractFigure.SetSubtractFigure ( Figure  figure)

Setting shape for subtraction.

Parameters
figureFigure for subtraction as SpaceVIL.Decoratons.Figure.

Implements SpaceVIL.Core.ISubtractFigure.


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