Represents a ScenePic TextPanel UI component. More...

#include <text_panel.h>

Public Member Functions
TextPanel &	title (const std::string &title)
	The title of the text panel. More...

const std::string &	title () const
	The title of the text panel. More...

TextPanel &	text (const std::string &text)
	The text within the text panel. More...

const std::string &	text () const
	The text within the text panel. More...

TextPanel &	input_text (const std::string &text)
	Sets the text inside the optional input box. More...

const std::string &	input_text () const
	Sets the text inside the optional input box. More...

std::string	to_string () const
	Return a JSON string representing the object. More...

JsonValue	to_json () const
	Convert this object into ScenePic json. More...

void	clear_script ()
	Call this if you are dumping a ScenePic script in multiple parts, e.g. More...

Friends
class	Scene

Detailed Description

Represents a ScenePic TextPanel UI component.

Member Function Documentation

◆ clear_script()

void scenepic::TextPanel::clear_script ( )

Call this if you are dumping a ScenePic script in multiple parts, e.g.

for client-server interactions, or when chunking a large visualization into multiple files.

◆ input_text() [1/2]

const std::string & scenepic::TextPanel::input_text ( ) const

Sets the text inside the optional input box.

◆ input_text() [2/2]

TextPanel & scenepic::TextPanel::input_text ( const std::string & text )

Sets the text inside the optional input box.

◆ text() [1/2]

const std::string & scenepic::TextPanel::text ( ) const

The text within the text panel.

◆ text() [2/2]

TextPanel & scenepic::TextPanel::text ( const std::string & text )

The text within the text panel.

◆ title() [1/2]

const std::string & scenepic::TextPanel::title ( ) const

The title of the text panel.

◆ title() [2/2]

TextPanel & scenepic::TextPanel::title ( const std::string & title )

The title of the text panel.

◆ to_json()

JsonValue scenepic::TextPanel::to_json ( ) const

Convert this object into ScenePic json.

Returns: a json value

◆ to_string()

std::string scenepic::TextPanel::to_string ( ) const

Return a JSON string representing the object.

Friends And Related Function Documentation

◆ Scene

friend class Scene

friend

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

src/include/scenepic/text_panel.h

Public Member Functions

Friends