VShape Class Reference

An object class that renders primitive shapes. Arguably more optimal than creating a VSprite and calling any of the Make graphic functions. More...

#include <VShape.h>

Inheritance diagram for VShape:

Public Types
typedef VObject	VSUPERCLASS
	Used to call parent class functions when they are overrided in class.
Public Types inherited from VObject
enum	SidesTouching : unsigned char {   TOUCHNONE = 0, TOUCHLEFT = 1 << 0, TOUCHRIGHT = 1 << 1, TOUCHTOP = 1 << 2,   TOUCHBOTTOM = 1 << 3, TOUCHWALL = TOUCHLEFT | TOUCHRIGHT, TOUCHALL = TOUCHLEFT | TOUCHRIGHT | TOUCHTOP | TOUCHBOTTOM }
	Flags for which sides are allowed to check if being overlapped for collision purposes.
typedef VBase	VSUPERCLASS
	Used to call parent class functions when they are overrided in class.

Public Member Functions
	VShape (float x=0, float y=0, float width=0, float height=0)
	VShape (sf::Vector2f Position, sf::Vector2f Size)
virtual void	Destroy () override
	Destroys object and any data that must be destroyed.
void	SetRectangle (float width, float height)
void	SetCircle (float radius, unsigned int pointCount=30)
void	SetConvex (std::vector< sf::Vector2f > &points)
void	SetCustom (sf::Shape *shape, float width, float height)
sf::Shape *	GetShape ()
void	SetFillTint (const sf::Color &tint)
void	SetOutlineTint (const sf::Color &tint)
void	SetOutlineThickness (float thickness)
const sf::Color &	GetFillTint ()
const sf::Color &	GetOutlineTint ()
float	GetOutlineThickness ()
void	SetTexture (sf::Texture *texture)
void	SetTextureFromFile (const sf::String &filename)
void	SetTextureRect (const sf::IntRect &rect)
virtual void	Draw (sf::RenderTarget &RenderTarget) override
Public Member Functions inherited from VObject
	VObject (sf::Vector2f position, sf::Vector2f size=sf::Vector2f())
	VObject (float x=0, float y=0, float width=0, float height=0)
void	SetPositionAtCentre (float x, float y)
void	SetPositionAtCentre (sf::Vector2f newPos)
bool	IsSolid ()
virtual void	Reset (sf::Vector2f newPos)
virtual void	Reset (float x, float y)
virtual void	Hurt (float damage)
virtual void	Update (float dt)
Public Member Functions inherited from VBase
virtual void	Kill ()
virtual void	Revive ()
	Revives the object by setting both alive and exists back to true.

Public Attributes
sf::Vector2f	Origin
	Origin point for rotation.
sf::Vector2f	Scale
	Scale transform.
sf::RenderStates	RenderState
	RenderState for the shape.
Public Attributes inherited from VObject
sf::Vector2f	Position
	Position of the object.
sf::Vector2f	Size
	Size of the object.
sf::Vector2f	Last
	Position of the object on the previous frame.
float	Radius = 0
	Radius amount for Circle Collisions.
float	Angle = 0
	Angle of object.
float	AngleVelocity = 0
	Velocity of rotation.
float	AngleAcceleration = 0
	Acceleration of rotation.
float	AngleDrag = 0
	Drag of rotation.
float	AngleMax = 10000
	Maximum Velocity of rotation.
bool	Moves = true
	If true, updates the objects position and angle.
sf::Vector2f	Velocity
	Velocity of movement.
sf::Vector2f	Acceleration
	Acceleration of movement.
sf::Vector2f	Drag
	Drag of movement.
sf::Vector2f	MaxVelocity
	Maximum velocity of movement.
sf::Vector2f	ScrollFactor
	The amount the object will appear to move when the camera scrolls (1.0f = Scrolls as fast as the camera, 0.5f = Scrolls half as fast as the camera). Good for parallax scrolling.
float	RotateFactor = 1
	The amount the object will appear to rotate when the camera rotates (1.0f = Rotates as fast as the camera, 0.5f = Rotates half as fast as the camera). Good for parallax scrolling.
float	ZoomFactor = 1
	The amount the object will appear to scale when the camera zooms (1.0f = Scales as fast as the camera, 0.5f = Scales half as fast as the camera). Good for parallax scrolling.
float	Elasticity = 0
	Bounciness of the object (0 assumes no bounce)
float	Mass = 1
	Mass of object in comparison to other objects in world.
float	Health = 100
	Standard health value (object dies if health is <= 0 when modified in the Hurt function)
bool	Immovable = false
	If true, the object will not change its velocity on collision.
unsigned char	Touching = SidesTouching::TOUCHNONE
	Which sides are currently touching (is reset on each Update call!)
unsigned char	WasTouching = SidesTouching::TOUCHNONE
	Which sides on previous frame were touching (is reset on each Update call!)
unsigned char	AllowCollisions = SidesTouching::TOUCHALL
	Which sides are allowed to check collisions for.
bool	CollisionXDrag = true
	Useful for moving platforms.
Public Attributes inherited from VBase
bool	active = true
	Base can be updated using Update if true.
bool	visible = true
	Base can be rendered using Draw if true.
bool	alive = true
	Helper member that is mainly used filter out behaviours to objects which aren't alive in the scene.
bool	exists = true
	Base can be updated and rendered if true, else it would no longer be treated as being part of the scene.
VType	type = NONE
	Base object type, typically set in the constructor of an inherited object to specify what type it is.
uint32_t	RefCount = 0
	Counts the amount of times the object is referenced in groups, ensures an object is only destroyed when no longer part of a single group.

Protected Member Functions
virtual void	updateTransform () override
	Update the tranform.
Protected Member Functions inherited from VObject
virtual void	updateMotion (float dt)

Additional Inherited Members
Static Public Member Functions inherited from VObject
static bool	separate (VObject *a, VObject *b)
static bool	separateCircle (VObject *a, VObject *b)
static bool	touchFlag (VObject *a, VObject *b)
static float	computeVelocity (float v, float a, float d, float max, float dt)
static bool	TestInView (const sf::View &renderTargetView, sf::View *defaultView, VObject *o, const sf::FloatRect &renderBox=sf::FloatRect())
Static Public Member Functions inherited from VBase
static const wchar_t *	VString (const char *fmt,...)
static void	VLog (const char *fmt,...)
static void	VLogError (const char *fmt,...)
static void	VClearLog ()
Static Public Attributes inherited from VObject
static float	SeparateBias
	Adds to the maximum overlap distance between objects.

Detailed Description

An object class that renders primitive shapes. Arguably more optimal than creating a VSprite and calling any of the Make graphic functions.

Constructor & Destructor Documentation

VShape() [1/2]

VShape::VShape	(	float	x = 0,
		float	y = 0,
		float	width = 0,
		float	height = 0
	)

Constructor creates a rectangle shape by default.

Parameters

x	X position of the shape.
y	Y position of the shape.
width	Width of the shape.
height	Height of the shape.

VShape() [2/2]

VShape::VShape	(	sf::Vector2f	Position,
		sf::Vector2f	Size
	)

Constructor creates a rectangle shape by default.

Parameters

Position	Position of the shape.
Size	Size of the shape.

Member Function Documentation

Draw()

virtual void VShape::Draw ( sf::RenderTarget &  RenderTarget )

overridevirtual

Renders the shape.

Parameters

RenderTarget

The game's sf::RenderTarget object to render data onto.

Reimplemented from VObject.

GetFillTint()

const sf::Color& VShape::GetFillTint

(

)

Returns

The colour of the shape's fill colour.

GetOutlineThickness()

float VShape::GetOutlineThickness

(

)

Returns

The thickness of the outline in thickness.

GetOutlineTint()

const sf::Color& VShape::GetOutlineTint

(

)

Returns

The colour of the shape's outline colour.

GetShape()

sf::Shape* VShape::GetShape

(

)

Returns

Return the pointer to the shape object.

SetCircle()

void VShape::SetCircle	(	float	radius,
		unsigned int	pointCount = 30
	)

Set the shape to a circle.

Parameters

radius	Radius of the new circle.
pointCount	The amount of points in the shape (because sf::Shape cannot render perfect circles, only a series of points that can make up a circle).

SetConvex()

void VShape::SetConvex

(

std::vector< sf::Vector2f > &

points

)

Set the shape to a convex shape.

Parameters

points

A list of points that will make up the shape.

SetCustom()

void VShape::SetCustom	(	sf::Shape *	shape,
		float	width,
		float	height
	)

Set the shape to a custom object.

Parameters

shape	Custom object that overrides sf::Shape.
width	Width of the new rectangle.
height	Height of the new rectangle.

SetFillTint()

void VShape::SetFillTint

(

const sf::Color &

tint

)

Parameters

tint	The colour that will fill the shape.

SetOutlineThickness()

void VShape::SetOutlineThickness

(

float

thickness

)

Parameters

thickness

The thickness of the outline in pixels.

SetOutlineTint()

void VShape::SetOutlineTint

(

const sf::Color &

tint

)

Parameters

tint	The colour that will outline the shape.

SetRectangle()

void VShape::SetRectangle	(	float	width,
		float	height
	)

Set the shape to a rectangle.

Parameters

width	Width of the new rectangle.
height	Height of the new rectangle.

SetTexture()

void VShape::SetTexture

(

sf::Texture *

texture

)

Parameters

texture

The texture you want to set to, gets destroyed once removed. NULL by default.

SetTextureFromFile()

void VShape::SetTextureFromFile

(

const sf::String &

filename

)

Parameters

filename

The file of the texture you want to set to.

SetTextureRect()

void VShape::SetTextureRect

(

const sf::IntRect &

rect

)

Parameters

rect	The area of the texture you want to be displayed on the shape, by default it's the full area.

---

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

• D:/Development/Libs/Vigilante-Game-Framework/VFrame/VShape.h