VectorShape Class Reference

The VectorShape class defines the vector shape from JugiMap Editor. More...

#include <jmVectorShapes.h>

Public Member Functions
	VectorShape ()
	Base constructor. More...
	VectorShape (bool _extra, int _dataFlags, const std::vector< jugimap::Parameter > &_parameters)
	Create a vector shape with the given data parameters *_probe*, *_dataFlags* and *_parameters*. More...
	VectorShape (GeometricShape *_geomShape)
	Create a vector shape with the given *_geomShape*. More...
	VectorShape (const VectorShape &vs)
	Copy constructor. More...
	~VectorShape ()
	Destructor. More...
GeometricShape *	GetGeometricShape ()
	Returns the geometric shape of this vector shape. More...
void	SetGeometricShape (GeometricShape *_geomShape)
	Set the geometric shape of this vector shape to *_geomShape*. More...
ShapeKind	GetKind ()
	Returns the kind of this shape. More...
int	GetDataFlags ()
	Returns the data flags of this vector shape. More...
std::vector< jugimap::Parameter > &	GetParameters ()
	Returns a reference to the vector of data parameters in this vector shape. More...
float	GetPathLength ()
	Returns the length of this vector shape. More...
Vec2f	GetPathPoint (float r)
	Returns a point along the path at the given parametric position r. More...
Vec2f	GetPathPoint (float r, float &directionAngle)
	Returns a point along the path at the given parametric position r. More...
bool	IsValid ()
	Returns true if this vector shape has a geometric object which is valid; otherwise returns false. More...
bool	IsClosed ()
	Returns true if this vector shape has a geometric object which is closed; otherwise returns false. More...

Detailed Description

The VectorShape class defines the vector shape from JugiMap Editor.

The VectorShape serves as a wrapper for a more lightweight GeometricShape object and is its owner.

Constructor & Destructor Documentation

VectorShape() [1/4]

VectorShape ( )

inline

Base constructor.

VectorShape() [2/4]

VectorShape ( bool  _extra, int  _dataFlags, const std::vector< jugimap::Parameter > &  _parameters  )

inline

Create a vector shape with the given data parameters *_probe*, *_dataFlags* and *_parameters*.

A geometric shape must be set before this vector shape will be ready to use.

VectorShape() [3/4]

VectorShape ( GeometricShape *  _geomShape )

inline

Create a vector shape with the given *_geomShape*.

VectorShape() [4/4]

VectorShape

(

const VectorShape &

vs

)

Copy constructor.

~VectorShape()

~VectorShape ( )

inline

Destructor.

Member Function Documentation

GetGeometricShape()

GeometricShape* GetGeometricShape ( )

inline

Returns the geometric shape of this vector shape.

SetGeometricShape()

void SetGeometricShape ( GeometricShape *  _geomShape )

inline

Set the geometric shape of this vector shape to *_geomShape*.

GetKind()

ShapeKind GetKind ( )

inline

Returns the kind of this shape.

GetDataFlags()

int GetDataFlags ( )

inline

Returns the data flags of this vector shape.

GetParameters()

std::vector<jugimap::Parameter>& GetParameters ( )

inline

Returns a reference to the vector of data parameters in this vector shape.

GetPathLength()

float GetPathLength ( )

inline

Returns the length of this vector shape.

GetPathPoint() [1/2]

Vec2f GetPathPoint ( float  r )

inline

Returns a point along the path at the given parametric position r.

GetPathPoint() [2/2]

Vec2f GetPathPoint ( float  r, float &  directionAngle  )

inline

Returns a point along the path at the given parametric position r.

IsValid()

bool IsValid ( )

inline

Returns true if this vector shape has a geometric object which is valid; otherwise returns false.

IsClosed()

bool IsClosed ( )

inline

Returns true if this vector shape has a geometric object which is closed; otherwise returns false.

---

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

• C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmVectorShapes.h
• C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmVectorShapes.cpp