scenepic 1.1.0
3D Visualization Made Easy
Public Member Functions | Public Attributes | List of all members
scenepic::Graph::VerticalRule Struct Reference

Represents a vertical line in a sparkline graph. More...

#include <graph.h>

Public Member Functions

 VerticalRule (std::int64_t frame, const Color &color=scenepic::Colors::Black, float line_width=1.0f)
 Constructor. More...
 
std::string to_string () const
 Returns a string representation of the margin. More...
 
JsonValue to_json () const
 Convert this object into ScenePic json. More...
 

Public Attributes

std::int64_t frame
 The frame at which to add the line. More...
 
Color color
 The color of the line. More...
 
float line_width
 The width of the line in pixels. More...
 

Detailed Description

Represents a vertical line in a sparkline graph.

Constructor & Destructor Documentation

◆ VerticalRule()

scenepic::Graph::VerticalRule::VerticalRule ( std::int64_t  frame,
const Color color = scenepic::Colors::Black,
float  line_width = 1.0f 
)

Constructor.

Parameters
framethe frame at which to add the line
colorthe color of the line
line_widththe width of the line in pixels

Member Function Documentation

◆ to_json()

JsonValue scenepic::Graph::VerticalRule::to_json ( ) const

Convert this object into ScenePic json.

Returns
a json value

◆ to_string()

std::string scenepic::Graph::VerticalRule::to_string ( ) const

Returns a string representation of the margin.

Member Data Documentation

◆ color

Color scenepic::Graph::VerticalRule::color

The color of the line.

◆ frame

std::int64_t scenepic::Graph::VerticalRule::frame

The frame at which to add the line.

◆ line_width

float scenepic::Graph::VerticalRule::line_width

The width of the line in pixels.


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