JugiMap Framework
SinglePointShape Struct Reference

The single point shape. More...

#include <jmVectorShapes.h>

Inherits GeometricShape.

Public Member Functions

bool IsValid () override
 Returns true if this shape is a valid geometric object; otherwise returns false. More...
 
void RebuildPath () override
 Rebuild the path from the current shape geometry. More...
 
Vec2f GetPathPoint (float p) override
 Returns a point along the path at the given parametric position p. More...
 
Vec2f GetPathPoint (float p, float &directionAngle) override
 Returns a point along the path at the given parametric position p. More...
 
- Public Member Functions inherited from GeometricShape
ShapeKind GetKind ()
 Returns the kind of this shape. More...
 
bool IsClosed ()
 Returns true if this shape is a closed geometric object; otherwise returns false. More...
 
void _SetClosed (bool _closed)
 Set the closed parameter when you create a geometric shape by hand. Do not change it for existing shapes! More...
 
std::vector< TShapePoint > & GetPath ()
 Returns a reference to the path vector of this geometric shape. More...
 
float GetPathLength ()
 Returns the length of the path. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from GeometricShape
static GeometricShapeCopy (GeometricShape *_geomShape)
 Create a new geometric object which is a copy of the given *_geomShape*. More...
 
static void Assign (GeometricShape *sSrc, GeometricShape *sDst)
 Assign the content of the given sSrc to the sDst. More...
 

Detailed Description

The single point shape.

Member Function Documentation

◆ IsValid()

bool IsValid ( )
inlineoverridevirtual

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

This function is usually called from the VectorShape::IsValid.

Implements GeometricShape.

◆ RebuildPath()

void RebuildPath ( )
overridevirtual

Rebuild the path from the current shape geometry.

This function is usually called from the VectorShape::RebuildPath.

Implements GeometricShape.

◆ GetPathPoint() [1/2]

Vec2f GetPathPoint ( float  p)
inlineoverridevirtual

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

This function is usually called from the VectorShape::GetPathPoint.

Parameters
pA parameter in the range of [0.0 - 1.0] where 0.0 gives the starting point and 1.0 gives the end point of the path.

Reimplemented from GeometricShape.

◆ GetPathPoint() [2/2]

Vec2f GetPathPoint ( float  p,
float &  directionAngle 
)
inlineoverridevirtual

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

This function is usually called from the VectorShape::GetPathPoint.

Parameters
pA parameter in the range of [0.0 - 1.0] where 0.0 gives the starting point and 1.0 gives the end point of the path.
directionAngleThe direction angle of the path at the returned point.

Reimplemented from GeometricShape.


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