Otter.Gradient Class Reference

Graphic that renders as a simple gradient between 4 points. More...

Inherits Otter.Graphic.

Public Types
enum	ColorPosition { TopLeft, TopRight, BottomRight, BottomLeft }

Public Member Functions
	Gradient (int width, int height, Color TopLeft, Color TopRight, Color BottomRight, Color BottomLeft)
	Create a new Gradient using 4 Colors for each corner. More...
	Gradient (Gradient copy)
	Create a new Gradient using another Gradient. More...
void	SetColor (Color color, ColorPosition position)
	Set the Color of a specific position. More...
Color	GetColor (ColorPosition position)
	Get the Color of a specific position. More...
Public Member Functions inherited from Otter.Graphic
Transformation	AddTransform (Transformation transform)
Transformation	AddTransform (Vector2 translation, Vector2 scale, Vector2 origin, float rotation)
Transformation	AddTransform ()
Transformation	RemoveTransformation (Transformation transform)
Transformation	PopTransformation ()
virtual void	ClearShader ()
	Removes the shader from the graphic. More...
void	SetPosition (float x, float y)
	Set the position of the Graphic. More...
void	SetPosition (Graphic g, float offsetX=0, float offsetY=0)
	Set the position of the Graphic. More...
void	SetPosition (Vector2 xy)
	Set the position of the Graphic. More...
void	SetOrigin (float x, float y)
	Set the origin of the Graphic. More...
void	SetOrigin (Vector2 xy)
	Set the origin of the Graphic. More...
void	SetTexture (string path)
	Set the Texture that the Graphic is using (if it is using one.) More...
void	SetTexture (Texture texture)
	Set the Texture that the Graphic is using (if it is using one.) More...
void	SetTexture (AtlasTexture atlasTexture)
	Set the Texture that the Graphic is using (if it is using one.) More...
virtual void	Update ()
	Update the graphic. More...
virtual void	CenterOrigin ()
	Centers the graphic origin. More...
virtual void	CenterOriginZero ()
	Centers the graphic origin while retaining its relative position. More...
virtual void	Render (float x=0, float y=0)
	Draws the graphic. More...

Protected Member Functions
override void	UpdateDrawable ()
	Updates the internal SFML data for rendering. More...
Protected Member Functions inherited from Otter.Graphic
void	Append (float x, float y, Color color, float u, float v)
void	Append (float x, float y, Color color=null)
virtual void	TextureChanged ()
virtual void	SFMLRender (Drawable drawable, float x=0, float y=0)

Additional Inherited Members
Public Attributes inherited from Otter.Graphic
List< Transformation >	Transforms = new List<Transformation>() { new Transformation() }
bool	Relative = true
	Determines if the Graphic is rendered relative to its Entity. More...
bool	Visible = true
	Determines if the Graphic will render. More...
float	ScrollX = 1
	The scroll factor for the x position. Used for parallax like effects. Values lower than 1 will scroll slower than the camera (appear to be further away) and values higher than 1 will scroll faster than the camera (appear to be closer.) More...
float	ScrollY = 1
	The scroll factor for the y position. Used for parallax like effects. Values lower than 1 will scroll slower than the camera (appear to be further away) and values higher than 1 will scroll faster than the camera (appear to be closer.) More...
float	ShakeX
	The horizontal amount to randomly offset the graphic by each frame. More...
float	ShakeY
	The vertial amount to randomly offset the graphic by each frame. More...
Rectangle	TextureRegion
	The region to render the Texture with. More...
Rectangle	AtlasRegion
	The Rectangle to render an AtlasTexture with. More...
Shader	Shader
	The shader to be applied to this graphic. More...
string	Name = "Graphic"
	The name of the graphic. More...
BlendMode	Blend = BlendMode.Alpha
	The blend mode to be applied to this graphic. More...
bool	RepeatX
	Determines if the image should be rendered multiple times horizontally. More...
bool	RepeatY
	Determines if the image should be rendered multiple times vertically. More...
Protected Attributes inherited from Otter.Graphic
VertexArray	SFMLVertices = new VertexArray(PrimitiveType.Quads)
Drawable	SFMLDrawable
float	RepeatSizeX
bool	roundRendering = true
bool	Dynamic
	If true the graphic will always update its drawable. More...
Properties inherited from Otter.Graphic
Transformation	Transform [get]
float	X [get, set]
	The X position of the Graphic. More...
float	Y [get, set]
	The Y position of the Graphic. More...
float	ScaleX [get, set]
	The horizontal scale of the graphic. Used in the final transformation. More...
float	ScaleY [get, set]
	The vertical scale of the graphic. Used in the final transformation. More...
float	Angle [get, set]
	The angle of rotation of the graphic. Used in the final transformation. More...
float	OriginX [get, set]
	The X origin point to scale and rotate the graphic with. Used in the final transformation. More...
float	OriginY [get, set]
	The Y origin point to scale and rotate the graphic with. Used in the final transformation. More...
Color	Color [get, set]
	The base color of the Graphic. Multiplies the vertices of the graphic by this color. More...
virtual Texture	Texture [get, set]
	The texture that the graphic is using. More...
float	Alpha [get, set]
	The base transparency of the graphic. A shortcut to access the base color's Alpha. More...
int	Width [get, set]
	The width of the Graphic. More...
int	Height [get, set]
	The height of the Graphic. More...
float	ScaledWidth [get, set]
	The width in pixels of the image after applying the X scale. More...
float	ScaledHeight [get, set]
	The height in pixels of the image after applying the Y scale. More...
virtual bool	Smooth [get, set]
	Smooth the texture of a sprite image while scaling it. More...
float	Scroll [get, set]
	Set both ScrollX and ScrollY. More...
float	HalfWidth [get]
	Half of the width. More...
float	HalfHeight [get]
	Half of the height. More...
float	Scale [set]
	Sets both the ScaleX and ScaleY at the same time. More...
bool	Repeat [set]
	Sets both RepeatX and RepeatY at the same time. More...
float	Shake [set]
	A shortcut to set both ShakeX and ShakeY. More...
float	Left [get]
	The X position of the left side of the Graphic. More...
float	Top [get]
	The Y position of the top of the Graphic. More...
float	Right [get]
	The X position of the right side of the Graphic. More...
float	Bottom [get]
	The Y position of the bottom of the Graphic. More...
int	TextureLeft [get]
	The X position of the left of the Texture. More...
int	TextureRight [get]
	The X position of the right of the Texture. More...
int	TextureTop [get]
	The Y position of the top of the Texture. More...
int	TextureBottom [get]
	The Y position of the bottom of the Texture. More...

Detailed Description

Graphic that renders as a simple gradient between 4 points.

Constructor & Destructor Documentation

Otter.Gradient.Gradient	(	int	width,
		int	height,
		Color	TopLeft,
		Color	TopRight,
		Color	BottomRight,
		Color	BottomLeft
	)

Create a new Gradient using 4 Colors for each corner.

Parameters

width	The width of the gradient.
height	The height of the gradient.
TopLeft	The Color of the top left corner.
TopRight	The Color of the top right corner.
BottomRight	The Color of the bottom right corner.
BottomLeft	The Color of the bottom left corner.

Otter.Gradient.Gradient

(

Gradient

copy

)

Create a new Gradient using another Gradient.

Parameters

copy	The source Gradient to copy.

Member Function Documentation

Color Otter.Gradient.GetColor

(

ColorPosition

position

)

Get the Color of a specific position.

Parameters

position

The position to get the Color of.

Returns

void Otter.Gradient.SetColor	(	Color	color,
		ColorPosition	position
	)

Set the Color of a specific position.

Parameters

color	The new Color.
position	The position to change the Color on.

override void Otter.Gradient.UpdateDrawable ( )

protectedvirtual

Updates the internal SFML data for rendering.

Reimplemented from Otter.Graphic.

---

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

• Otter/Graphics/Drawables/Gradient.cs