com.spvessel.spacevil.Decorations.SubtractFigure Class Reference

SubtractFigure is visual effect for applying to item's shape. More...

Inherits com.spvessel.spacevil.Core.InterfaceSubtractFigure, and com.spvessel.spacevil.Core.InterfaceEffect.

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...
List< ItemAlignment >	getAlignment ()
	Getting shape's allignment within the item. More...
void	setAlignment (ItemAlignment... alignments)
	Setting shape's allignment within the item. More...

Detailed Description

SubtractFigure is visual effect for applying to item's shape.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure and com.spvessel.spacevil.Core.InterfaceEffect.

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

Constructor & Destructor Documentation

SubtractFigure()

com.spvessel.spacevil.Decorations.SubtractFigure.SubtractFigure

(

Figure

figure

)

Constructs subtract effect with specified shape.

Parameters

figure

Figure for subtraction as com.spvessel.spacevil.Decorations.Figure.

Member Function Documentation

getAlignment()

List<ItemAlignment> com.spvessel.spacevil.Decorations.SubtractFigure.getAlignment

(

)

Getting shape's allignment within the item.

Returns

Alignment as com.spvessel.spacevil.Flags.ItemAlignment.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

getEffectName()

String com.spvessel.spacevil.Decorations.SubtractFigure.getEffectName

(

)

Getting the effect name.

Returns

Returns name SubtractEffect as java.lang.String.

Implements com.spvessel.spacevil.Core.InterfaceEffect.

getHeightScale()

float com.spvessel.spacevil.Decorations.SubtractFigure.getHeightScale

(

)

Getting height scaling.

Returns

Height scaling.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

getSubtractFigure()

Figure com.spvessel.spacevil.Decorations.SubtractFigure.getSubtractFigure

(

)

Getting the current figure for subtraction.

Returns

Figure for subtraction as com.spvessel.spacevil.Decorations.Figure.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

getWidthScale()

float com.spvessel.spacevil.Decorations.SubtractFigure.getWidthScale

(

)

Getting width scaling.

Returns

Width scaling.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

getXOffset()

int com.spvessel.spacevil.Decorations.SubtractFigure.getXOffset

(

)

Getting shape's shift by X-axis.

Returns

X axis shift.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

getYOffset()

int com.spvessel.spacevil.Decorations.SubtractFigure.getYOffset

(

)

Getting shape's shift by Y-axis.

Returns

Y axis shift.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

setAlignment()

void com.spvessel.spacevil.Decorations.SubtractFigure.setAlignment

(

ItemAlignment...

alignments

)

Setting shape's allignment within the item.

Parameters

alignments

Alignment as com.spvessel.spacevil.Flags.ItemAlignment.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

setPositionOffset()

void com.spvessel.spacevil.Decorations.SubtractFigure.setPositionOffset	(	int	x,
		int	y
	)

Setting shape's shift by X, Y axis.

Parameters

x	X axis shift.
y	Y axis shift.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

setSizeScale()

void com.spvessel.spacevil.Decorations.SubtractFigure.setSizeScale	(	float	wScale,
		float	hScale
	)

Setting shape's scaling factors for width and height.

Parameters

wScale	Scaling factor for width.
hScale	Scaling factor for height.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

setSubtractFigure()

void com.spvessel.spacevil.Decorations.SubtractFigure.setSubtractFigure

(

Figure

figure

)

Setting shape for subtraction.

Parameters

figure

Figure for subtraction as com.spvessel.spacevil.Decorations.Figure.

Implements com.spvessel.spacevil.Core.InterfaceSubtractFigure.

---

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

• SubtractFigure.java