#include <CUPathNode.h>

Inheritance diagram for cugl::scene2::PathNode:

Public Member Functions
	PathNode ()

	~PathNode ()

bool	initWithVertices (const std::vector< Vec2 > &vertices, float stroke, poly2::Joint joint=poly2::Joint::NONE, poly2::EndCap cap=poly2::EndCap::NONE, bool closed=true)

bool	initWithPoly (const Poly2 &poly, float stroke, poly2::Joint joint=poly2::Joint::NONE, poly2::EndCap cap=poly2::EndCap::NONE)

virtual bool	initWithData (const Scene2Loader *loader, const std::shared_ptr< JsonValue > &data) override

void	setStroke (float stroke)

float	getStroke () const

void	setClosed (bool closed)

bool	getClosed () const

void	setJoint (poly2::Joint joint)

poly2::Joint	getJoint () const

void	setCap (poly2::EndCap cap)

poly2::EndCap	getCap () const

virtual void	setPolygon (const std::vector< Vec2 > &vertices) override

virtual void	setPolygon (const Poly2 &poly) override

virtual void	setPolygon (const Rect rect) override

float	getExtrudedContentWidth () const

float	getExtrudedContentHeight () const

const Size	getExtrudedContentSize () const

const Rect	getExtrudedContentBounds () const

virtual void	draw (const std::shared_ptr< SpriteBatch > &batch, const Mat4 &transform, Color4 tint) override

Public Member Functions inherited from cugl::scene2::TexturedNode
	TexturedNode ()

	~TexturedNode ()

virtual void	dispose () override

virtual bool	init () override

bool	init (const std::vector< Vec2 > &vertices)

bool	init (const Poly2 &poly)

bool	init (const Rect rect)

bool	initWithFile (const std::string &filename)

bool	initWithFile (const std::string &filename, const std::vector< Vec2 > &vertices)

bool	initWithFile (const std::string &filename, const Poly2 &poly)

bool	initWithFile (const std::string &filename, const Rect rect)

bool	initWithTexture (const std::shared_ptr< Texture > &texture)

bool	initWithTexture (const std::shared_ptr< Texture > &texture, const std::vector< Vec2 > &vertices)

bool	initWithTexture (const std::shared_ptr< Texture > &texture, const Poly2 &poly)

bool	initWithTexture (const std::shared_ptr< Texture > &texture, const Rect rect)

void	setTexture (const std::string &filename)

void	setTexture (const std::shared_ptr< Texture > &texture)

std::shared_ptr< Texture > &	getTexture ()

const std::shared_ptr< Texture > &	getTexture () const

const Poly2 &	getPolygon () const

virtual void	shiftPolygon (float dx, float dy)

const Rect	getBoundingRect () const

void	setBlendFunc (GLenum srcFactor, GLenum dstFactor)

GLenum	getSourceBlendFactor () const

GLenum	getDestinationBlendFactor () const

void	setBlendEquation (GLenum equation)

GLenum	getBlendEquation () const

void	flipHorizontal (bool flag)

bool	isFlipHorizontal () const

void	flipVertical (bool flag)

bool	isFlipVertical () const

virtual std::string	toString (bool verbose=false) const override

bool	isAbsolute () const

void	setAbsolute (bool flag)

virtual void	setAnchor (const Vec2 anchor) override

virtual void	setContentSize (const Size size) override

virtual void	setContentSize (float width, float height) override

void	refresh ()

const std::shared_ptr< Gradient > &	getGradient () const

void	setGradient (const std::shared_ptr< Gradient > &gradient)

Public Member Functions inherited from cugl::scene2::SceneNode
	SceneNode ()

	~SceneNode ()

virtual bool	initWithPosition (const Vec2 pos)

bool	initWithPosition (float x, float y)

virtual bool	initWithBounds (const Size size)

bool	initWithBounds (float width, float height)

virtual bool	initWithBounds (const Rect rect)

bool	initWithBounds (float x, float y, float width, float height)

virtual SceneNode *	copy (SceneNode *dst)

unsigned int	getTag () const

void	setTag (unsigned int tag)

const std::string &	getName () const

void	setName (const std::string &name)

	operator std::string () const

const Vec2	getPosition () const

void	setPosition (const Vec2 &position)

void	setPosition (float x, float y)

float	getPositionX (void) const

void	setPositionX (float x)

float	getPositionY (void) const

void	setPositionY (float y)

Vec2	getWorldPosition () const

const Size	getContentSize () const

float	getContentWidth () const

void	setContentWidth (float width)

float	getContentHeight () const

void	setContentHeight (float height)

Size	getSize () const

float	getWidth () const

float	getHeight () const

Rect	getBoundingBox () const

void	setAnchor (float x, float y)

const Vec2	getAnchor () const

Vec2	getAnchorInPixels ()

Color4	getColor () const

virtual void	setColor (Color4 color)

Color4	getAbsoluteColor ()

bool	isVisible () const

void	setVisible (bool visible)

bool	hasRelativeColor ()

void	setRelativeColor (bool flag)

std::shared_ptr< Scissor >	getScissor () const

void	setScissor (const std::shared_ptr< Scissor > &scissor)

void	setScissor ()

const Vec2	getScale () const

float	getScaleX () const

float	getScaleY () const

void	setScale (float scale)

void	setScale (const Vec2 vec)

void	setScale (float sx, float sy)

float	getAngle ()

void	setAngle (float angle)

const Mat4 &	getAlternateTransform ()

void	setAlternateTransform (const Mat4 &transform)

bool	withAlternateTransform ()

void	chooseAlternateTransform (bool active)

const Mat4 &	getNodeToParentTransform () const

Mat4	getParentToNodeTransform () const

Mat4	getNodeToWorldTransform () const

Mat4	getWorldToNodeTransform () const

Vec2	screenToNodeCoords (const Vec2 screenPoint) const

Vec2	worldToNodeCoords (const Vec2 worldPoint) const

Vec2	nodeToScreenCoords (const Vec2 nodePoint) const

Vec2	nodeToWorldCoords (const Vec2 nodePoint) const

Vec2	parentToNodeCoords (const Vec2 parentPoint) const

Vec2	nodeToParentCoords (const Vec2 nodePoint) const

void	setZOrder (int z)

int	getZOrder () const

bool	isZDirty () const

void	sortZOrder ()

size_t	getChildCount () const

std::shared_ptr< SceneNode >	getChild (unsigned int pos)

const std::shared_ptr< SceneNode > &	getChild (unsigned int pos) const

template<typename T >
std::shared_ptr< T >	getChild (unsigned int pos) const

std::shared_ptr< SceneNode >	getChildByTag (unsigned int tag) const

template<typename T >
std::shared_ptr< T >	getChildByTag (unsigned int tag) const

std::shared_ptr< SceneNode >	getChildByName (const std::string name) const

template<typename T >
std::shared_ptr< T >	getChildByName (const std::string name) const

std::vector< std::shared_ptr< SceneNode > >	getChildren ()

const std::vector< std::shared_ptr< SceneNode > > &	getChildren () const

void	addChild (std::shared_ptr< SceneNode > child)

virtual void	addChild (const std::shared_ptr< SceneNode > &child, int zval)

void	addChildWithTag (const std::shared_ptr< SceneNode > &child, unsigned int tag)

void	addChildWithTag (const std::shared_ptr< SceneNode > &child, unsigned int tag, int zval)

void	addChildWithName (const std::shared_ptr< SceneNode > &child, const std::string &name)

void	addChildWithName (const std::shared_ptr< SceneNode > &child, const std::string &name, int zval)

void	swapChild (const std::shared_ptr< SceneNode > &child1, const std::shared_ptr< SceneNode > &child2, bool inherit=false)

SceneNode *	getParent ()

const SceneNode *	getParent () const

Scene2 *	getScene ()

const Scene2 *	getScene () const

void	removeFromParent ()

virtual void	removeChild (unsigned int pos)

void	removeChild (const std::shared_ptr< SceneNode > &child)

void	removeChildByTag (unsigned int tag)

void	removeChildByName (const std::string name)

virtual void	removeAllChildren ()

virtual void	render (const std::shared_ptr< SpriteBatch > &batch, const Mat4 &transform, Color4 tint)

virtual void	render (const std::shared_ptr< SpriteBatch > &batch)

const std::shared_ptr< Layout > &	getLayout () const

void	setLayout (const std::shared_ptr< Layout > &layout)

virtual void	doLayout ()

Static Public Member Functions
static std::shared_ptr< PathNode >	alloc ()

static std::shared_ptr< PathNode >	allocWithVertices (const std::vector< Vec2 > &vertices, float stroke, poly2::Joint joint=poly2::Joint::NONE, poly2::EndCap cap=poly2::EndCap::NONE, bool closed=true)

static std::shared_ptr< PathNode >	allocWithPoly (const Poly2 &poly, float stroke, poly2::Joint joint=poly2::Joint::NONE, poly2::EndCap cap=poly2::EndCap::NONE)

static std::shared_ptr< PathNode >	allocWithRect (const Rect rect, float stroke, poly2::Joint joint=poly2::Joint::NONE, poly2::EndCap cap=poly2::EndCap::NONE)

static std::shared_ptr< SceneNode >	allocWithData (const Scene2Loader *loader, const std::shared_ptr< JsonValue > &data)

Static Public Member Functions inherited from cugl::scene2::SceneNode
static std::shared_ptr< SceneNode >	alloc ()

static std::shared_ptr< SceneNode >	allocWithPosition (const Vec2 pos)

static std::shared_ptr< SceneNode >	allocWithPosition (float x, float y)

static std::shared_ptr< SceneNode >	allocWithBounds (const Size size)

static std::shared_ptr< SceneNode >	allocWithBounds (float width, float height)

static std::shared_ptr< SceneNode >	allocWithBounds (const Rect rect)

static std::shared_ptr< SceneNode >	allocWithBounds (float x, float y, float width, float height)

static std::shared_ptr< SceneNode >	allocWithData (const Scene2Loader *loader, const std::shared_ptr< JsonValue > &data)

Protected Attributes
Poly2	_extrusion

Rect	_extrbounds

bool	_closed

float	_stroke

poly2::Joint	_joint

poly2::EndCap	_endcap

Protected Attributes inherited from cugl::scene2::TexturedNode
std::string	_classname

std::shared_ptr< Texture >	_texture

Poly2	_polygon

bool	_absolute

bool	_stretch

bool	_rendered

Mesh< SpriteVertex2 >	_mesh

GLenum	_blendEquation

GLenum	_srcFactor

GLenum	_dstFactor

bool	_flipHorizontal

bool	_flipVertical

std::shared_ptr< Gradient >	_gradient

std::shared_ptr< Gradient >	_spriteGrad

Protected Attributes inherited from cugl::scene2::SceneNode
Vec2	_position

Vec2	_anchor

Size	_contentSize

Color4	_tintColor

bool	_hasParentColor

bool	_isVisible

std::shared_ptr< Scissor >	_scissor

Vec2	_scale

float	_angle

Mat4	_transform

bool	_useTransform

Mat4	_combined

std::vector< std::shared_ptr< SceneNode > >	_children

SceneNode *	_parent

Scene2 *	_graph

std::shared_ptr< Layout >	_layout

int	_childOffset

unsigned int	_tag

std::string	_name

size_t	_hashOfName

int	_zOrder

bool	_zDirty

std::shared_ptr< JsonValue >	_json

Additional Inherited Members
Protected Member Functions inherited from cugl::scene2::TexturedNode
void	clearRenderData ()

void	updateTextureCoords ()

	CU_DISALLOW_COPY_AND_ASSIGN (TexturedNode)

Detailed Description

This is a scene graph node to represent a path with width.

At first glance, it would appear that this class is unnecessary. A path with width, produced by SimpleExtruder is a solid polygon. This polygon can, in turn, be used in conjunction with PolygonNode.

However, there are some subtle issues. In particular, mitres and joints may mean that a PathNode and WireNode at the same position may not line up with one another. This is undesirable. Hence this is a special polygon node that takes into account that it is an extruded path.

One of the side effects of this is that the content size of the node is defined by the wireframe path, NOT the extruded path. If you want the bounds of the extruded path (relative to Node space), you should use the method getExtrudedContentBounds(). Additionally, the anchor point is relative to the content size not the extruded size. This means that the extruded path may be to the left of the origin even when the anchor is (0,0).

Because paths have width, it is natural to texture them. However, generally you will only want to create a path with the degenerate texture (to draw a solid, colored path). Hence, none of the static constructors take a texture. You are free to update the texture after creation, if you wish.

The polygon is specified in image coordinates. Image coordinates are different from texture coordinates. Their origin is at the bottom-left corner of the file, and each pixel is one unit. This makes specifying to polygon more natural for irregular shapes.

This means that a polygon with vertices (0,0), (width,0), (width,height), and (0,height) would be identical to a sprite node. However, a polygon with vertices (0,0), (2*width,0), (2*width,2*height), and (0,2*height) would tile the sprite (given the wrap settings) twice both horizontally and vertically. A uniform translation of the polygon (in contrast to the node itself) will not move the shape on the the screen. Instead, it will just change the part or the texture it uses.

For example, suppose the texture has given width and height. We have one polygon with vertices (0,0), (width/2,0), (width/2,height/2), and (0,height/2). We have another polygon with vertices (width/2,height/2), (width,height/2), (width,height), and (width/2,height). Both polygons would create a rectangle of size (width/2,height/2). centered at the node position. However, the first would use the bottom left part of the texture, while the second would use the top right.

You can disable these features at any time by setting the attribute absolute to true. Do this will place the polygon vertices in their absolute positions in Node space. This will also disable anchor functions (setting the anchor as the bottom left corner), since anchors do not make sense when we are drawing vertices directly into the coordinate space.

Constructor & Destructor Documentation

◆ PathNode()

cugl::scene2::PathNode::PathNode ( )

Creates an empty path node.

You must initialize this PathNode before use.

NEVER USE A CONSTRUCTOR WITH NEW. If you want to allocate an object on the heap, use one of the static constructors instead.

◆ ~PathNode()

cugl::scene2::PathNode::~PathNode ( )

inline

Releases all resources allocated with this node.

This will release, but not necessarily delete the associated texture. However, the polygon and drawing commands will be deleted and no longer safe to use.

Member Function Documentation

◆ alloc()

static std::shared_ptr<PathNode> cugl::scene2::PathNode::alloc ( )

inlinestatic

Returns an empty path node.

The underlying polygon is empty, and must be set via setPolygon().

Returns: an empty path node.

◆ allocWithData()

static std::shared_ptr<SceneNode> cugl::scene2::PathNode::allocWithData	(	const Scene2Loader *	loader,
		const std::shared_ptr< JsonValue > &	data
	)

inlinestatic

Returns a newly allocated node with the given JSON specificaton.

This initializer is designed to receive the "data" object from the JSON passed to Scene2Loader. This JSON format supports all of the attribute values of its parent class. In addition, it supports the following additional attributes:

 "texture":  The name of a previously loaded texture asset
 "polygon":  An even array of polygon vertices (numbers)
 "indices":  An array of unsigned ints defining triangles from the
             the vertices. The array size should be a multiple of 3.
 'stroke':   A number specifying the stroke width.
 'joint':    One of 'mitre', 'bevel', or 'round'.
 'cap':      One of 'square' or 'round'.
 'closed':   A boolean specifying if the path is closed.

All attributes are optional. However, it is generally a good idea to specify EITHER the texture or the polygon.

Parameters

loader	The scene loader passing this JSON file
data	The JSON object specifying the node

Returns: a newly allocated node with the given JSON specificaton.

◆ allocWithPoly()

static std::shared_ptr<PathNode> cugl::scene2::PathNode::allocWithPoly	(	const Poly2 &	poly,
		float	stroke,
		poly2::Joint	joint = `poly2::Joint::NONE`,
		poly2::EndCap	cap = `poly2::EndCap::NONE`
	)

inlinestatic

Returns a path node with the given polygon and stroke width.

The polygon must have geometry Geometry#IMPLICIT or Geometry#PATH. An IMPLICIT geometry will be considered closed and traversed accordingly. However, if the geometry is PATH, then the polygon will remain as given and the traversal (closed or open) will be inferred from the indices.

Once the traversal of the polygon is finalized, this method will e extrude that polygon with the current joint and cap. This method uses SimpleExtruder, as it is safe for framerate calculation.

Parameters

poly	The polygon to texture (expressed in image space)
stroke	The stroke width of the extruded path.
joint	The joint between extrusion line segments.
cap	The end caps of the extruded paths.

Returns: a path node with the given polygon and stroke width.

◆ allocWithRect()

static std::shared_ptr<PathNode> cugl::scene2::PathNode::allocWithRect	(	const Rect	rect,
		float	stroke,
		poly2::Joint	joint = `poly2::Joint::NONE`,
		poly2::EndCap	cap = `poly2::EndCap::NONE`
	)

inlinestatic

Returns a path node with the given rect and stroke width.

The rectangle will be converted into a Poly2, using the standard outline. This is the same as passing Poly2(rect,false). The traversal will be CLOSED. It will then be extruded with the current joint and cap. PathNode objects share a single extruder, so this constructor is not thread safe.

Parameters

rect	The rectangle for to texture.
stroke	The stroke width of the extruded path.
joint	The joint between extrusion line segments.
cap	The end caps of the extruded paths.

Returns: a path with the given rect and stroke width.

◆ allocWithVertices()

static std::shared_ptr<PathNode> cugl::scene2::PathNode::allocWithVertices	(	const std::vector< Vec2 > &	vertices,
		float	stroke,
		poly2::Joint	joint = `poly2::Joint::NONE`,
		poly2::EndCap	cap = `poly2::EndCap::NONE`,
		bool	closed = `true`
	)

inlinestatic

Returns a path node with the given vertices and stroke width.

The polygon will be extruded using the given sequence of vertices. First it will traverse the vertices according to the rule of this node (e.g. is it closed or open). Then it will extrude that polygon with the current joint and cap. This method uses SimpleExtruder, as it is safe for framerate calculation.

Parameters

vertices	The vertices to texture (expressed in image space)
stroke	The stroke width of the extruded path.
joint	The joint between extrusion line segments.
cap	The end caps of the extruded paths.
closed	The whether the vertex path is open or closed.

Returns: a path node with the given vertices and stroke width.

◆ draw()

virtual void cugl::scene2::PathNode::draw	(	const std::shared_ptr< SpriteBatch > &	batch,
		const Mat4 &	transform,
		Color4	tint
	)

overridevirtual

Draws this Node via the given SpriteBatch.

This method only worries about drawing the current node. It does not attempt to render the children.

This is the method that you should override to implement your custom drawing code. You are welcome to use any OpenGL commands that you wish. You can even skip use of the SpriteBatch. However, if you do so, you must flush the SpriteBatch by calling end() at the start of the method. in addition, you should remember to call begin() at the start of the method.

This method provides the correct transformation matrix and tint color. You do not need to worry about whether the node uses relative color. This method is called by render() and these values are guaranteed to be correct. In addition, this method does not need to check for visibility, as it is guaranteed to only be called when the node is visible.

Parameters

batch	The SpriteBatch to draw with.
transform	The global transformation matrix.
tint	The tint to blend with the Node color.

Implements cugl::scene2::TexturedNode.

◆ getCap()

poly2::EndCap cugl::scene2::PathNode::getCap ( ) const

inline

Returns the cap shape at the ends of the path.

Returns: the cap shape at the ends of the path.

◆ getClosed()

bool cugl::scene2::PathNode::getClosed ( ) const

inline

Returns whether the path is closed.

If set to true, this will smooth the polygon to remove all gaps, regardless of the original inidices in the polygon. Furthermore, previous information about existing gaps is lost, so that setting the value back to false will only open the curve at the end.

Returns: whether the path is closed.

◆ getExtrudedContentBounds()

const Rect cugl::scene2::PathNode::getExtrudedContentBounds ( ) const

inline

Returns the bounding box of the extruded content.

This method is similar to getExtrudedContentSize() in that it returns the extra content size created by the stroke width, mitres, and caps. In addition, it returns the actual bounds of the path within Node space.

Unlike getBoundingBox(), this method is unaffected by any transforms on this node.

Returns: the bounding box of the extruded content.

◆ getExtrudedContentHeight()

float cugl::scene2::PathNode::getExtrudedContentHeight ( ) const

inline

Returns the height of the extruded content.

This method is an alternative to getContentHeight(). That method only returns the content height of the path polygon; it does not include the stroke width, mitres, and caps. This method includes the extra height of the extruded path.

Returns: the height of the extruded content.

◆ getExtrudedContentSize()

const Size cugl::scene2::PathNode::getExtrudedContentSize ( ) const

inline

Returns the size of the extruded content.

This method is an alternative to getContentSize(). That method only returns the content size of the path polygon; it does not include the stroke width, mitres, and caps. This method includes the extra size of the extruded path.

Returns: the size of the extruded content.

◆ getExtrudedContentWidth()

float cugl::scene2::PathNode::getExtrudedContentWidth ( ) const

inline

Returns the width of the extruded content.

This method is an alternative to getContentWidth(). That method only returns the content width of the path polygon; it does not include the stroke width, mitres, and caps. This method includes the extra width of the extruded path.

Returns: the width of the extruded content.

◆ getJoint()

poly2::Joint cugl::scene2::PathNode::getJoint ( ) const

inline

Returns the joint type between path segments.

Returns: the joint type between path segments.

◆ getStroke()

float cugl::scene2::PathNode::getStroke ( ) const

inline

Returns the stroke width of the path.

Returns: the stroke width of the path.

◆ initWithData()

virtual bool cugl::scene2::PathNode::initWithData	(	const Scene2Loader *	loader,
		const std::shared_ptr< JsonValue > &	data
	)

overridevirtual

Initializes a node with the given JSON specificaton.

This initializer is designed to receive the "data" object from the JSON passed to Scene2Loader. This JSON format supports all of the attribute values of its parent class. In addition, it supports the following additional attributes:

 "texture":  The name of a previously loaded texture asset
 "polygon":  An even array of polygon vertices (numbers)
 "indices":  An array of unsigned ints defining triangles from the
             the vertices. The array size should be a multiple of 3.
 'stroke':   A number specifying the stroke width.
 'joint':    One of 'mitre', 'bevel', or 'round'.
 'cap':      One of 'square' or 'round'.
 'closed':   A boolean specifying if the path is closed.

All attributes are optional. However, it is generally a good idea to specify EITHER the texture or the polygon.

Parameters

loader	The scene loader passing this JSON file
data	The JSON object specifying the node

Returns: true if initialization was successful.

Reimplemented from cugl::scene2::TexturedNode.

◆ initWithPoly()

bool cugl::scene2::PathNode::initWithPoly	(	const Poly2 &	poly,
		float	stroke,
		poly2::Joint	joint = `poly2::Joint::NONE`,
		poly2::EndCap	cap = `poly2::EndCap::NONE`
	)

Intializes a path node with the given polygon and stroke width.

You do not need to set the texture; rendering this into a SpriteBatch will simply use the blank texture. Hence the wireframe will have a solid color.

The polygon must have geometry Geometry#IMPLICIT or Geometry#PATH. An IMPLICIT geometry will be considered closed and traversed accordingly. However, if the geometry is PATH, then the polygon will remain as given and the traversal (closed or open) will be inferred from the indices.

Once the traversal of the polygon is finalized, this method will e extrude that polygon with the current joint and cap. This method uses SimpleExtruder, as it is safe for framerate calculation.

Parameters

poly	The polygon to texture (expressed in image space)
stroke	The stroke width of the extruded path.
joint	The joint between extrusion line segments.
cap	The end caps of the extruded paths.

Returns: true if the path node is initialized properly, false otherwise.

◆ initWithVertices()

bool cugl::scene2::PathNode::initWithVertices	(	const std::vector< Vec2 > &	vertices,
		float	stroke,
		poly2::Joint	joint = `poly2::Joint::NONE`,
		poly2::EndCap	cap = `poly2::EndCap::NONE`,
		bool	closed = `true`
	)

Intializes a path with the given vertices and stroke width.

You do not need to set the texture; rendering this into a SpriteBatch will simply use the blank texture. Hence the wireframe will have a solid color.

The polygon will be extruded using the given sequence of vertices. First it will traverse the vertices according to the rule of this node (e.g. is it closed or open). Then it will extrude that polygon with the current joint and cap. This method uses SimpleExtruder, as it is safe for framerate calculation.

Parameters

vertices	The vertices to texture (expressed in image space)
stroke	The stroke width of the extruded path.
joint	The joint between extrusion line segments.
cap	The end caps of the extruded paths.
closed	The whether the vertex path is open or closed.

Returns: true if the path node is initialized properly, false otherwise.

◆ setCap()

void cugl::scene2::PathNode::setCap ( poly2::EndCap cap )

Sets the cap shape at the ends of the path.

This method affects the extruded polygon, but not the original path polygon.

Parameters

cap	The cap shape at the ends of the path.

◆ setClosed()

void cugl::scene2::PathNode::setClosed ( bool closed )

Sets whether the path is closed.

If set to true, this will smooth the polygon to remove all gaps, regardless of the original inidices in the polygon. Furthermore, previous information about existing gaps is lost, so that setting the value back to false will only open the curve at the end.

Parameters

closed Whether the path is closed.

◆ setJoint()

void cugl::scene2::PathNode::setJoint ( poly2::Joint joint )

Sets the joint type between path segments.

This method affects the extruded polygon, but not the original path polygon.

Parameters

joint The joint type between path segments

◆ setPolygon() [1/3]

virtual void cugl::scene2::PathNode::setPolygon ( const Poly2 & poly )

overridevirtual

Sets the polygon to the given one in texture space.

The polygon must have geometry Geometry#IMPLICIT or Geometry#PATH. An IMPLICIT geometry will be traversed according to whehter this node is closed or open. If the geometry is PATH, then the polygon will remain as given if this node is open, but it will be smoothed (removing all gaps) if it is closed.

Once the traversal of the polygon is finalized, this method will extrude that polygon with the current joint and cap. This method uses SimpleExtruder, as it is safe for framerate calculation.

Parameters

poly	The polygon to texture

Reimplemented from cugl::scene2::TexturedNode.

◆ setPolygon() [2/3]

virtual void cugl::scene2::PathNode::setPolygon ( const Rect rect )

overridevirtual

Sets the texture polygon to one equivalent to the given rect.

The rectangle will be converted into a Poly2, using the standard outline. However, the closure of the ends will depend upon the current setting of this node. An open rectangle is open on the left side.

Once the traversal of the rectangle is finalized, this method will extrude that rect with the current joint and cap. This method uses SimpleExtruder, as it is safe for framerate calculation.

Parameters

rect	The rectangle to texture

Implements cugl::scene2::TexturedNode.

◆ setPolygon() [3/3]

virtual void cugl::scene2::PathNode::setPolygon ( const std::vector< Vec2 > & vertices )

overridevirtual

Sets the polgon to the vertices expressed in texture space.

The polygon will be extruded using the given sequence of vertices. First it will traverse the vertices according to the rule of this node (e.g. is it closed or open). Then it will extrude that polygon with the current joint and cap. This method uses SimpleExtruder, as it is safe for framerate calculation.

Parameters

vertices The vertices to texture

Implements cugl::scene2::TexturedNode.

◆ setStroke()

void cugl::scene2::PathNode::setStroke ( float stroke )

Sets the stroke width of the path.

This method affects the extruded polygon, but not the source path polygon.

Parameters

stroke The stroke width of the path

Member Data Documentation

◆ _closed

bool cugl::scene2::PathNode::_closed

protected

Whether or not the polygon path is closed.

◆ _endcap

poly2::EndCap cugl::scene2::PathNode::_endcap

protected

The shape of the two end caps of the path.

◆ _extrbounds

Rect cugl::scene2::PathNode::_extrbounds

protected

The bounds of the extruded shape

◆ _extrusion

Poly2 cugl::scene2::PathNode::_extrusion

protected

The extrusion polygon, when the stroke > 0

◆ _joint

poly2::Joint cugl::scene2::PathNode::_joint

protected

The joint between segments of the path.

◆ _stroke

float cugl::scene2::PathNode::_stroke

protected

The stroke width of this path.

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

include/cugl/scene2/graph/CUPathNode.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PathNode()

◆ ~PathNode()

Member Function Documentation

◆ alloc()

◆ allocWithData()

◆ allocWithPoly()

◆ allocWithRect()

◆ allocWithVertices()

◆ draw()

◆ getCap()

◆ getClosed()

◆ getExtrudedContentBounds()

◆ getExtrudedContentHeight()

◆ getExtrudedContentSize()

◆ getExtrudedContentWidth()

◆ getJoint()

◆ getStroke()

◆ initWithData()

◆ initWithPoly()

◆ initWithVertices()

◆ setCap()

◆ setClosed()

◆ setJoint()

◆ setPolygon() [1/3]

◆ setPolygon() [2/3]

◆ setPolygon() [3/3]

◆ setStroke()

Member Data Documentation

◆ _closed

◆ _endcap

◆ _extrbounds

◆ _extrusion

◆ _joint

◆ _stroke