Struct sfml::graphics::ConvexShape

pub struct ConvexShape<'s> { /* fields omitted */ }

Specialized shape representing a convex polygon

It is important to keep in mind that a convex shape must always be... convex, otherwise it may not be drawn correctly. Moreover, the points must be defined in order; using a random order would result in an incorrect shape.

Methods

impl<'s> ConvexShape<'s>

pub fn new(points_count: u32) -> ConvexShape<'s>

Create a new convex shape

Arguments

• points_count - The number of point for the convex shape

pub fn with_texture(points_count: u32, texture: &'s Texture) -> ConvexShape<'s>

Create a new convex shape with a texture

Arguments

• texture - The texture to apply to the convex shape
• points_count - The number of point for the convex shape

pub fn set_point<P: Into<Vector2f>>(&mut self, index: u32, point: P)

Set the position of a point.

Don't forget that the polygon must remain convex, and the points need to stay ordered! set_point_count must be called first in order to set the total number of points. The result is undefined if index is out of the valid range.

Arguments

• index - Index of the point to change, in range [0 .. get_point_count() - 1]
• point - New position of the point

pub fn set_point_count(&mut self, count: u32)

Set the number of points of a convex

Arguments

• count - New number of points of the convex

Important traits for ConvexShapePoints

impl Iterator for ConvexShapePoints type Item = Vector2f;

pub fn points(&self) -> ConvexShapePoints

Return an immutable iterator over all the points of the ConvexShape

Trait Implementations

impl<'s> Drawable for ConvexShape<'s>

fn draw<'a: 'shader, 'texture, 'shader, 'shader_texture>(
    &'a self,
    target: &mut dyn RenderTarget,
    states: RenderStates<'texture, 'shader, 'shader_texture>
)

Draw a drawable object into a RenderTarget

impl<'s> Shape<'s> for ConvexShape<'s>

fn set_texture(&mut self, texture: &'s Texture, reset_rect: bool)

Changes the source texture of the shape.

fn disable_texture(&mut self)

Disables texturing for this shape.

fn set_texture_rect(&mut self, rect: &IntRect)

Sets the sub-rectangle of the texture that the shape will display.

fn set_fill_color(&mut self, color: Color)

Sets the fill color of the shape.

fn set_outline_color(&mut self, color: Color)

Sets the outline color of the shape.

fn set_outline_thickness(&mut self, thickness: f32)

Sets the thickness of the shape's outline.

fn texture(&self) -> Option<&'s Texture>

Gets the source texture of the shape.

fn texture_rect(&self) -> IntRect

Gets the sub-rectangle of the texture displayed by the shape.

fn fill_color(&self) -> Color

Gets the fill color of this shape.

fn outline_color(&self) -> Color

Gets the outline color of this shape.

fn outline_thickness(&self) -> f32

Gets the outline thickness of this shape.

fn point_count(&self) -> u32

Gets the total number of points of the shape.

fn point(&self, index: u32) -> Vector2f

Gets a point of the shape.

fn local_bounds(&self) -> FloatRect

Gets the local bounding rectangle of the entity.

fn global_bounds(&self) -> FloatRect

Gets the global (non-minimal) bounding rectangle of the entity.

impl<'s> Transformable for ConvexShape<'s>

fn set_position<P: Into<Vector2f>>(&mut self, position: P)

Sets the position of the object.

fn set_rotation(&mut self, angle: f32)

Set the orientation of the object.

fn set_scale<S: Into<Vector2f>>(&mut self, scale: S)

Sets the scale factors of the object.

fn set_origin<O: Into<Vector2f>>(&mut self, origin: O)

Sets the local origin of the object.

fn position(&self) -> Vector2f

Gets the position of the object.

fn rotation(&self) -> f32

Gets the rotation of the object.

fn get_scale(&self) -> Vector2f

Gets the current scale of the object.

fn origin(&self) -> Vector2f

Gets the local origin of the object.

fn move_<O: Into<Vector2f>>(&mut self, offset: O)

Moves the object by a given offset.

fn rotate(&mut self, angle: f32)

Rotates the object.

fn scale<F: Into<Vector2f>>(&mut self, factors: F)

Scales the object.

fn transform(&self) -> Transform

Gets the combined transform of the object.

fn inverse_transform(&self) -> Transform

Gets the inverse combined transform of the object.

impl<'s> Drop for ConvexShape<'s>

fn drop(&mut self)

Executes the destructor for this type.

impl<'s> Clone for ConvexShape<'s>

fn clone(&self) -> ConvexShape<'s>

Return a new ConvexShape or panic! if there is not enough memory

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'s> Debug for ConvexShape<'s>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.