org.jsfml.graphics

Class ConvexShape

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.graphics.Shape

org.jsfml.graphics.ConvexShape

All Implemented Interfaces:

Drawable, Transformable

public class ConvexShape
extends Shape

Specialized shape representing a convex polygon.

Field Summary

Fields inherited from class org.jsfml.graphics.Shape

points, pointsNeedUpdate

Constructor Summary

Constructors

Constructor and Description
ConvexShape() Constructs a new empty polygon.
ConvexShape(int points) Constructs a new empty polygon and allocates a certain amount of points.
ConvexShape(Vector2f... points) Constructs a new polygon from a given set of points.

Method Summary

Methods

Modifier and Type	Method and Description
Transform	getInverseTransform() Gets the inverse of the current transformation matrix.
Vector2f	getOrigin() Gets the origin of this object.
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.
Transform	getTransform() Gets the current transformation matrix.
void	move(float x, float y) Moves this object.
void	move(Vector2f v) Moves the object.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
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	setOrigin(float x, float y) Sets the rotation, scaling and drawing origin of this object.
void	setPoint(int i, Vector2f v) Sets a point of the polygon.
void	setPointCount(int pointCount) Sets the amount of points that belong to the polygon.
void	setPoints(Vector2f... points) Sets the points of the polygon.
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	setScale(float x, float y) Sets the scaling of this object, using its origin as the scaling center.

Methods inherited from class org.jsfml.graphics.Shape

draw, getFillColor, getGlobalBounds, getLocalBounds, getOutlineColor, getOutlineThickness, getPoint, getPointCount, getTexture, getTextureRect, setFillColor, setOrigin, setOutlineColor, setOutlineThickness, setPosition, setRotation, setScale, setTexture, setTexture, setTextureRect

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize

Methods inherited from class java.lang.Object

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

Constructor Detail

ConvexShape

public ConvexShape()

Constructs a new empty polygon.

ConvexShape

public ConvexShape(int points)

Constructs a new empty polygon and allocates a certain amount of points.

This is equal to calling setPointCount(int) directly after construction of the polygon.

Parameters:

points - the amount of points of the polygon.

ConvexShape

public ConvexShape(Vector2f... points)

Constructs a new polygon from a given set of points.

This is equal to calling setPoints(org.jsfml.system.Vector2f...) directly after construction of the polygon.

Parameters:

points - the points of the polygon.

Method Detail

nativeCreate

@Deprecated
protected long nativeCreate()

Deprecated.

Description copied from class: SFMLNativeObject

Creates a new native SFML object of the represented SFML class in the JVM memory heap.

Specified by:

nativeCreate in class SFMLNativeObject

Returns:

the pointer to the newly created native SFML object.

nativeSetExPtr

@Deprecated
protected void nativeSetExPtr()

Deprecated.

Description copied from class: SFMLNativeObject

This method is expected to fill the extra pointers array, if any.

It is called after the object has been created or wrapped around an already existing pointer.

Specified by:

nativeSetExPtr in class SFMLNativeObject

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Specified by:

nativeDelete in class SFMLNativeObject

setPointCount

public void setPointCount(int pointCount)

Sets the amount of points that belong to the polygon.

Parameters:

pointCount - the amount of points of the polygon.

setPoint

public void setPoint(int i,
            Vector2f v)

Sets a point of the polygon.

Parameters:

i - the index of the point to set. Note that this index must be within the bounds of the polygon's point count, ie the point count needs to be set properly using setPointCount(int) first.

v - the point to set at the given index.

setPoints

public void setPoints(Vector2f... points)

Sets the points of the polygon.

The use of this method equals consecutive calls of setPointCount(int) and setPoint(int, org.jsfml.system.Vector2f) for each point in the given array.

Parameters:

points - the points of the polygon.

getPoints

public Vector2f[] getPoints()

Description copied from class: Shape

Gets all the points of the shape.

Overrides:

getPoints in class Shape

Returns:

an array containing the points of the shape.

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.