org.jsfml.graphics

Class Shape

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.graphics.Shape

All Implemented Interfaces:

Drawable, Transformable

Direct Known Subclasses:

CircleShape, ConvexShape, RectangleShape

public abstract class Shape
extends SFMLNativeObject
implements Drawable

Abstract base class for (optionally) textured shapes with (optional) outlines.

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector2f[]	points
protected boolean	pointsNeedUpdate

Constructor Summary

Constructors

Constructor and Description
Shape() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	draw(RenderTarget target, RenderStates states) Draws the object to a render target.
Color	getFillColor() Gets the shape's current fill color.
FloatRect	getGlobalBounds() Gets the text's global bounding rectangle in the scene, taking the text's transformation into account.
Transform	getInverseTransform() Gets the inverse of the current transformation matrix.
FloatRect	getLocalBounds() Gets the text's local bounding rectangle, not taking the text's transformation into account.
Vector2f	getOrigin() Gets the origin of this object.
Color	getOutlineColor() Gets the shape's current outline color.
float	getOutlineThickness() Gets the shape's current outline thickness.
Vector2f	getPoint(int i) Gets a point of the shape.
int	getPointCount() Gets the amount of points that defines this shape.
Vector2f[]	getPoints() Gets all the points of the shape.
Vector2f	getPosition() Gets the position of this object.
float	getRotation() Gets the rotation angle of this object.
Vector2f	getScale() Gets the scaling of this object.
ConstTexture	getTexture() Gets the shape's current texture.
IntRect	getTextureRect() Gets the shape's current texture portion.
Transform	getTransform() Gets the current transformation matrix.
void	move(float x, float y) Moves this object.
void	move(Vector2f v) Moves the object.
void	rotate(float angle) Rotates this object around its origin.
void	scale(float x, float y) Scales the object, using its origin as the scaling center.
void	scale(Vector2f factors) Scales the object, using its origin as the scaling center.
void	setFillColor(Color color) Sets the fill color of the shape.
void	setOrigin(float x, float y) Sets the rotation, scaling and drawing origin of this object.
void	setOrigin(Vector2f v) Sets the rotation, scaling and drawing origin of this object.
void	setOutlineColor(Color color) Sets the outline color of the shape.
void	setOutlineThickness(float thickness) Sets the thickness of the shape's outline.
void	setPosition(float x, float y) Sets the position of this object in the scene so that its origin will be exactly on it.
void	setPosition(Vector2f v) Sets the position of this object in the scene so that its origin will be exactly on it.
void	setRotation(float angle) Sets the rotation of this object around its origin.
void	setScale(float x, float y) Sets the scaling of this object, using its origin as the scaling center.
void	setScale(Vector2f v) Sets the scaling of this object, using its origin as the scaling center.
void	setTexture(ConstTexture texture) Sets the texture of the shape without affecting the texture rectangle.
void	setTexture(ConstTexture texture, boolean resetRect) Sets the texture of the shape.
void	setTextureRect(IntRect rect) Sets the portion of the texture that will be used for drawing.

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize, nativeCreate, nativeDelete, nativeSetExPtr

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pointsNeedUpdate

protected boolean pointsNeedUpdate

points

protected Vector2f[] points

Constructor Detail

Shape

public Shape()

Default constructor.

Method Detail

setTexture

public void setTexture(ConstTexture texture,
              boolean resetRect)

Sets the texture of the shape.

The texture may be null if no texture is to be used.

Parameters:

texture - the texture of the shape, or null to indicate that no texture is to be used.

resetRect - true to reset the texture rect, false otherwise.

setTexture

public final void setTexture(ConstTexture texture)

Sets the texture of the shape without affecting the texture rectangle.

The texture may be null if no texture is to be used.

Parameters:

texture - the texture of the shape, or null to indicate that no texture is to be used.

setTextureRect

public void setTextureRect(IntRect rect)

Sets the portion of the texture that will be used for drawing.

An empty rectangle can be passed to indicate that the whole texture shall be used.

The width and / or height of the rectangle may be negative to indicate that the respective axis should be flipped. For example, a width of -32 will result in a sprite that is 32 pixels wide and flipped horizontally.

Parameters:

rect - the texture portion.

setFillColor

public void setFillColor(Color color)

Sets the fill color of the shape.

Parameters:

color - the new fill color of the shape, or Color.TRANSPARENT to indicate that the shape should not be filled.

setOutlineColor

public void setOutlineColor(Color color)

Sets the outline color of the shape.

Parameters:

color - the new outline color of the shape.

setOutlineThickness

public void setOutlineThickness(float thickness)

Sets the thickness of the shape's outline.

Parameters:

thickness - the thickness of the shape's outline, or 0 to indicate that no outline should be drawn.

getTexture

public ConstTexture getTexture()

Gets the shape's current texture.

Returns:

the shape's current texture.

getTextureRect

public IntRect getTextureRect()

Gets the shape's current texture portion.

Returns:

the shape's current texture portion.

getFillColor

public Color getFillColor()

Gets the shape's current fill color.

Returns:

the shape's current fill color.

getOutlineColor

public Color getOutlineColor()

Gets the shape's current outline color.

Returns:

the shape's current outline color.

getOutlineThickness

public float getOutlineThickness()

Gets the shape's current outline thickness.

Returns:

the shape's current outline thickness.

getPointCount

public int getPointCount()

Gets the amount of points that defines this shape.

Returns:

the amount of points that defines this shape.

getPoint

public Vector2f getPoint(int i)

Gets a point of the shape.

Parameters:

i - the index of the point to retrieve.

Returns:

the point at the given index.

getPoints

public Vector2f[] getPoints()

Gets all the points of the shape.

Returns:

an array containing the points of the shape.

getLocalBounds

public FloatRect getLocalBounds()

Gets the text's local bounding rectangle, not taking the text's transformation into account.

Returns:

the text's local bounding rectangle.

See Also:

Sprite.getGlobalBounds()

getGlobalBounds

public FloatRect getGlobalBounds()

Gets the text's global bounding rectangle in the scene, taking the text's transformation into account.

Returns:

the text's global bounding rectangle.

See Also:

Text.getLocalBounds()

setPosition

public void setPosition(Vector2f v)

Description copied from interface: Transformable

Sets the position of this object in the scene so that its origin will be exactly on it.

Specified by:

setPosition in interface Transformable

Parameters:

v - the new position.

setRotation

public void setRotation(float angle)

Description copied from interface: Transformable

Sets the rotation of this object around its origin.

Specified by:

setRotation in interface Transformable

Parameters:

angle - the new rotation angle in degrees.

setScale

public void setScale(Vector2f v)

Description copied from interface: Transformable

Sets the scaling of this object, using its origin as the scaling center.

Specified by:

setScale in interface Transformable

Parameters:

v - the new scaling factors.

setOrigin

public void setOrigin(Vector2f v)

Description copied from interface: Transformable

Sets the rotation, scaling and drawing origin of this object.

Specified by:

setOrigin in interface Transformable

Parameters:

v - the new origin.

draw

public void draw(RenderTarget target,
        RenderStates states)

Description copied from interface: Drawable

Draws the object to a render target.

Specified by:

draw in interface Drawable

Parameters:

target - the target to draw this object on.

states - the current render states.

setPosition

public final void setPosition(float x,
               float y)

Description copied from interface: Transformable

Sets the position of this object in the scene so that its origin will be exactly on it.

Specified by:

setPosition in interface Transformable

Parameters:

x - the new X coordinate.

y - the new Y coordinate.

setScale

public final void setScale(float x,
            float y)

Description copied from interface: Transformable

Sets the scaling of this object, using its origin as the scaling center.

Specified by:

setScale in interface Transformable

Parameters:

x - the new X scaling factor.

y - the new Y scaling factor.

setOrigin

public final void setOrigin(float x,
             float y)

Description copied from interface: Transformable

Sets the rotation, scaling and drawing origin of this object.

Specified by:

setOrigin in interface Transformable

Parameters:

x - the new X coordinate of the origin.

y - the new Y coordinate of the origin.

getPosition

public Vector2f getPosition()

Description copied from interface: Transformable

Gets the position of this object.

Specified by:

getPosition in interface Transformable

Returns:

the current position.

getRotation

public float getRotation()

Description copied from interface: Transformable

Gets the rotation angle of this object.

Specified by:

getRotation in interface Transformable

Returns:

the current rotation angle in degrees.

getScale

public Vector2f getScale()

Description copied from interface: Transformable

Gets the scaling of this object.

Specified by:

getScale in interface Transformable

Returns:

the current scaling factors.

getOrigin

public Vector2f getOrigin()

Description copied from interface: Transformable

Gets the origin of this object.

Specified by:

getOrigin in interface Transformable

Returns:

the current origin.

move

public final void move(float x,
        float y)

Description copied from interface: Transformable

Moves this object.

Specified by:

move in interface Transformable

Parameters:

x - the X offset added to the current position.

y - the Y offset added to the current position.

move

public final void move(Vector2f v)

Description copied from interface: Transformable

Moves the object.

Specified by:

move in interface Transformable

Parameters:

v - the offset vector added to the current position.

rotate

public final void rotate(float angle)

Description copied from interface: Transformable

Rotates this object around its origin.

Specified by:

rotate in interface Transformable

Parameters:

angle - the rotation angle in degrees.

scale

public final void scale(float x,
         float y)

Description copied from interface: Transformable

Scales the object, using its origin as the scaling center.

Specified by:

scale in interface Transformable

Parameters:

x - the X scaling factor.

y - the Y scaling factor.

scale

public final void scale(Vector2f factors)

Description copied from interface: Transformable

Scales the object, using its origin as the scaling center.

Specified by:

scale in interface Transformable

Parameters:

factors - the scaling factors.

getTransform

public Transform getTransform()

Description copied from interface: Transformable

Gets the current transformation matrix.

Specified by:

getTransform in interface Transformable

Returns:

the current transformation.

getInverseTransform

public Transform getInverseTransform()

Description copied from interface: Transformable

Gets the inverse of the current transformation matrix.

Specified by:

getInverseTransform in interface Transformable

Returns:

the inverse of the current transform.