Graphic type that is used to represent a static image. More...

Inherited by Otter.ImageSet, Otter.Spritemap< TAnimType >, and Otter.Surface.

Public Member Functions
	Image (string source=null)
	Creates a new Image using a filepath to a texture. More...

	Image (Texture texture)
	Creates a new Image using a Texture. More...

	Image (AtlasTexture texture)
	Creates a new Image using an AtlasTexture. More...

	Image (int width, int height)
	Creates a new Image using a specified width and height. 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...

Static Public Member Functions
static Image	CreateRectangle (int width, int height, Color color)
	Creates a rectangle. More...

static Image	CreateRectangle (Color color)
	Creates a rectangle the size of the active Game window. More...

static Image	CreateRectangle ()
	Creates a simple black rectangle the size of the active Game window. More...

static Image	CreateRectangle (int width, int height)
	Creates a rectangle. More...

static Image	CreateRectangle (int size)
	Creates a rectangle. More...

static Image	CreateRectangle (int size, Color color)
	Creates a rectangle. More...

static Image	CreateCircle (int radius, Color color)
	Create a circle. More...

static Image	CreateCircle (int radius)
	Create a white circle. More...

Static Public Attributes
static int	CirclePointCount = 24
	The amount of points to use when rendering a circle shape. More...

Protected Member Functions
override void	TextureChanged ()

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	SFMLRender (Drawable drawable, float x=0, float y=0)

Protected Attributes
bool	flipX = false

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
Rectangle	ClippingRegion `[get, set]`
	Defines which area of the Image to show. More...

bool	FlippedX `[get, set]`
	Flip the texture coordinates on the X axis. More...

bool	FlippedY `[get, set]`
	Flip the texture coordinates on the Y axis. More...

Color	OutlineColor `[get, set]`
	The outline color of the Image (only applies to circles and rectangles.) More...

float	OutlineThickness `[get, set]`
	The outline thickness of the Image (only applies to circles and rectangles.) 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...

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

Detailed Description

Graphic type that is used to represent a static image.

Constructor & Destructor Documentation

Otter.Image.Image ( string source = null )

Creates a new Image using a filepath to a texture.

Parameters

source	The filepath of the texture.
clip	Where to clip the texture.

Otter.Image.Image ( Texture texture )

Creates a new Image using a Texture.

Parameters

texture The Texture to use.

Otter.Image.Image ( AtlasTexture texture )

Creates a new Image using an AtlasTexture.

Parameters

texture The AtlasTexture to use.

Otter.Image.Image	(	int	width,
		int	height
	)

Creates a new Image using a specified width and height.

Parameters

width	The width of the Image.
height	The hight of the Image.

Member Function Documentation

static Image Otter.Image.CreateCircle	(	int	radius,
		Color	color
	)

static

Create a circle.

Parameters

radius	The radius of the circle.
color	The color of the circle.

Returns: A new image containing the circle.

static Image Otter.Image.CreateCircle ( int radius )

static

Create a white circle.

Parameters

radius The radius of the circle.

Returns: A new image containing the circle.

static Image Otter.Image.CreateRectangle	(	int	width,
		int	height,
		Color	color
	)

static

Creates a rectangle.

Parameters

width	The width of the rectangle.
height	The height of the rectangle.
color	The color of the rectangle.

Returns: A new image containing the rectangle.

static Image Otter.Image.CreateRectangle ( Color color )

static

Creates a rectangle the size of the active Game window.

Parameters

color The color of the rectangle.

Returns: A new image containing the rectangle.

static Image Otter.Image.CreateRectangle ( )

static

Creates a simple black rectangle the size of the active Game window.

Returns: A new image containing the rectangle.

static Image Otter.Image.CreateRectangle	(	int	width,
		int	height
	)

static

Creates a rectangle.

Parameters

width	The width of the rectangle.
height	The height of the rectangle.

Returns: A new image containing the rectangle.

static Image Otter.Image.CreateRectangle ( int size )

static

Creates a rectangle.

Parameters

size	The width and height of the rectangle.

Returns: A new image containing the rectangle.

static Image Otter.Image.CreateRectangle	(	int	size,
		Color	color
	)

static

Creates a rectangle.

Parameters

size	The width and height of the rectangle.
color	The color of the rectangle.

Returns: A new image containing the rectangle.

override void Otter.Image.UpdateDrawable ( )

protectedvirtual

Updates the internal SFML data for rendering.

Reimplemented from Otter.Graphic.

Member Data Documentation

int Otter.Image.CirclePointCount = 24

static

The amount of points to use when rendering a circle shape.

Property Documentation

Rectangle Otter.Image.ClippingRegion

getset

Defines which area of the Image to show.

bool Otter.Image.FlippedX

getset

Flip the texture coordinates on the X axis.

bool Otter.Image.FlippedY

getset

Flip the texture coordinates on the Y axis.

Color Otter.Image.OutlineColor

getset

The outline color of the Image (only applies to circles and rectangles.)

float Otter.Image.OutlineThickness

getset

The outline thickness of the Image (only applies to circles and rectangles.)

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

Otter/Graphics/Drawables/Image.cs

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation