openpine::graph::Polyline Class Reference

Represents a polyline graph. More...

#include <polyline.hpp>

Public Member Functions
	Polyline (const ffi::Polyline *p)
uintptr_t	pointsLength () const
	Returns the number of points in the polyline.
std::optional< ffi::PolylinePoint >	point (uintptr_t idx) const
	Returns the point at idx.
bool	curved () const
	Gets whether the polyline is rendered as a smooth curve.
bool	closed () const
	Gets whether the polyline is closed.
std::optional< uint32_t >	lineColor () const
	Gets the optional line color.
std::optional< uint32_t >	fillColor () const
	Gets the optional fill color.
LineStyle	lineStyle () const
	Gets the line style.
int32_t	lineWidth () const
	Gets the line width.
bool	forceOverlay () const
	Gets whether the polyline is forced to render as overlay.

Detailed Description

Represents a polyline graph.

Definition at line 25 of file polyline.hpp.

Constructor & Destructor Documentation

Polyline()

openpine::graph::Polyline::Polyline ( const ffi::Polyline * p )

inline

Definition at line 30 of file polyline.hpp.

Member Function Documentation

closed()

bool openpine::graph::Polyline::closed ( ) const

inline

Gets whether the polyline is closed.

Definition at line 57 of file polyline.hpp.

curved()

bool openpine::graph::Polyline::curved ( ) const

inline

Gets whether the polyline is rendered as a smooth curve.

Definition at line 52 of file polyline.hpp.

fillColor()

std::optional< uint32_t > openpine::graph::Polyline::fillColor ( ) const

inline

Gets the optional fill color.

Definition at line 74 of file polyline.hpp.

forceOverlay()

bool openpine::graph::Polyline::forceOverlay ( ) const

inline

Gets whether the polyline is forced to render as overlay.

Definition at line 96 of file polyline.hpp.

lineColor()

std::optional< uint32_t > openpine::graph::Polyline::lineColor ( ) const

inline

Gets the optional line color.

Definition at line 62 of file polyline.hpp.

lineStyle()

LineStyle openpine::graph::Polyline::lineStyle ( ) const

inline

Gets the line style.

Definition at line 86 of file polyline.hpp.

lineWidth()

int32_t openpine::graph::Polyline::lineWidth ( ) const

inline

Gets the line width.

Definition at line 91 of file polyline.hpp.

point()

std::optional< ffi::PolylinePoint > openpine::graph::Polyline::point ( uintptr_t idx ) const

inline

Returns the point at idx.

Definition at line 40 of file polyline.hpp.

pointsLength()

uintptr_t openpine::graph::Polyline::pointsLength ( ) const

inline

Returns the number of points in the polyline.

Definition at line 35 of file polyline.hpp.

---

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

• cpp/include/visuals/polyline.hpp