Vuo  2.3.2
Public Member Functions | Static Public Attributes | List of all members
VuoComment Class Reference

Description

Creates a comment.

See also
VuoCompilerComment
VuoRendererComment

Definition at line 24 of file VuoComment.hh.

Public Member Functions

 VuoComment (string content="", int x=0, int y=0, int width=240, int height=120, VuoNode::TintColor tintColor=VuoNode::TintNone)
 Creates a base Comment instance. More...
 
string getContent (void)
 Returns the text content of the comment. More...
 
void setContent (string content)
 Sets the text content of the comment. More...
 
int getX (void)
 Returns the x coordinate at which the top left corner of this comment instance is drawn in the editor. More...
 
void setX (int x)
 Sets the x coordinate at which the top left corner of this comment instance is drawn in the editor. More...
 
int getY (void)
 Returns the y coordinate at which the top left corner of this comment instance is drawn in the editor. More...
 
void setY (int y)
 Sets the y coordinate at which the top left corner of this comment instance is drawn in the editor. More...
 
int getWidth (void)
 Returns the width of the comment instance as drawn in the editor. More...
 
void setWidth (int width)
 Sets the width of the comment instance as drawn in the editor. More...
 
int getHeight (void)
 Returns the height of the comment instance as drawn in the editor. More...
 
void setHeight (int height)
 Sets the height of the comment instance as drawn in the editor. More...
 
VuoNode::TintColor getTintColor (void)
 Returns this comment's tint color. More...
 
string getTintColorGraphvizName (void)
 Returns this comment's tint color as a Graphviz color name, or emptystring if there is no tint. More...
 
void setTintColor (enum VuoNode::TintColor tintColor)
 Sets this comment's tint color. More...
 
- Public Member Functions inherited from VuoBase< VuoCompilerComment, VuoRendererComment >
 VuoBase (string id)
 Creates a base class. More...
 
void setCompiler (VuoCompilerComment *compiler)
 Sets the base class instance's compiler detail class instance. More...
 
VuoCompilerCommentgetCompiler (void) const
 Returns the base class instance's compiler detail class instance. More...
 
bool hasCompiler (void) const
 Returns true if this base class instance has a compiler detail. More...
 
void setRenderer (VuoRendererComment *renderer)
 Sets the base class instance's renderer detail class instance. More...
 
VuoRendererCommentgetRenderer (void) const
 Returns the base class instance's renderer detail class instance. More...
 
bool hasRenderer (void) const
 Returns true if this base class instance has a renderer detail. More...
 

Static Public Attributes

static const string commentTypeName = "vuo.comment"
 The type name of the comment, for use in Graphviz. More...
 

Constructor & Destructor Documentation

◆ VuoComment()

VuoComment::VuoComment ( string  content = "",
int  x = 0,
int  y = 0,
int  width = 240,
int  height = 120,
VuoNode::TintColor  tintColor = VuoNode::TintNone 
)

Creates a base Comment instance.

Definition at line 18 of file VuoComment.cc.

Member Function Documentation

◆ getContent()

string VuoComment::getContent ( void  )

Returns the text content of the comment.

Definition at line 32 of file VuoComment.cc.

◆ getHeight()

int VuoComment::getHeight ( void  )

Returns the height of the comment instance as drawn in the editor.

Definition at line 96 of file VuoComment.cc.

◆ getTintColor()

enum VuoNode::TintColor VuoComment::getTintColor ( void  )

Returns this comment's tint color.

Definition at line 104 of file VuoComment.cc.

◆ getTintColorGraphvizName()

string VuoComment::getTintColorGraphvizName ( void  )

Returns this comment's tint color as a Graphviz color name, or emptystring if there is no tint.

Definition at line 120 of file VuoComment.cc.

◆ getWidth()

int VuoComment::getWidth ( void  )

Returns the width of the comment instance as drawn in the editor.

Definition at line 80 of file VuoComment.cc.

◆ getX()

int VuoComment::getX ( void  )

Returns the x coordinate at which the top left corner of this comment instance is drawn in the editor.

Definition at line 48 of file VuoComment.cc.

◆ getY()

int VuoComment::getY ( void  )

Returns the y coordinate at which the top left corner of this comment instance is drawn in the editor.

Definition at line 64 of file VuoComment.cc.

◆ setContent()

void VuoComment::setContent ( string  content)

Sets the text content of the comment.

Definition at line 40 of file VuoComment.cc.

◆ setHeight()

void VuoComment::setHeight ( int  height)

Sets the height of the comment instance as drawn in the editor.

Definition at line 104 of file VuoComment.cc.

◆ setTintColor()

void VuoComment::setTintColor ( enum VuoNode::TintColor  tintColor)

Sets this comment's tint color.

Definition at line 128 of file VuoComment.cc.

◆ setWidth()

void VuoComment::setWidth ( int  width)

Sets the width of the comment instance as drawn in the editor.

Definition at line 88 of file VuoComment.cc.

◆ setX()

void VuoComment::setX ( int  x)

Sets the x coordinate at which the top left corner of this comment instance is drawn in the editor.

Definition at line 56 of file VuoComment.cc.

◆ setY()

void VuoComment::setY ( int  y)

Sets the y coordinate at which the top left corner of this comment instance is drawn in the editor.

Definition at line 72 of file VuoComment.cc.

Member Data Documentation

◆ commentTypeName

const string VuoComment::commentTypeName = "vuo.comment"
static

The type name of the comment, for use in Graphviz.

Definition at line 29 of file VuoComment.hh.


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