Vuo  2.3.2
Macros | Typedefs | Functions

Description

Combination vertical + horizontal alignment.

Typedefs

typedef int64_t VuoAnchor
 Combination vertical + horizontal alignment. More...
 

Functions

VuoAnchor VuoAnchor_makeFromJson (json_object *js)
 Decodes the JSON object js to create a new value. More...
 
json_objectVuoAnchor_getJson (const VuoAnchor value)
 Encodes value as a JSON object. More...
 
char * VuoAnchor_getSummary (const VuoAnchor value)
 Returns a compact string representation of value. More...
 
VuoList_VuoAnchor VuoAnchor_getAllowedValues (void)
 Returns a list of values that instances of this type can have. More...
 
static VuoAnchor VuoAnchor_make (VuoHorizontalAlignment horizontal, VuoVerticalAlignment vertical) __attribute__((const))
 Returns a VuoAnchor with horizontal and vertical alignments. More...
 
static VuoHorizontalAlignment VuoAnchor_getHorizontal (VuoAnchor anchor) __attribute__((const))
 Returns the horizontal component of a VuoAnchor. More...
 
static VuoVerticalAlignment VuoAnchor_getVertical (VuoAnchor anchor) __attribute__((const))
 Returns the horizontal component of a VuoAnchor. More...
 
static VuoAnchor VuoAnchor_makeCentered (void) __attribute__((const))
 Returns a VuoAnchor with both horizontal and vertical alignments centered. More...
 
VuoPoint2d VuoAnchor_getOffset (VuoAnchor anchor)
 Returns an offset (-.5, 0, or .5) for each axis of the anchor. More...
 
bool VuoAnchor_areEqual (const VuoAnchor value1, const VuoAnchor value2)
 Returns true if the two values are equal. More...
 
bool VuoAnchor_isLessThan (const VuoAnchor value1, const VuoAnchor value2)
 Returns true if the value1 is less than value2. More...
 
VuoAnchor VuoAnchor_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoAnchor_getString (const VuoAnchor value)
 Automatically generated function. More...
 
void VuoAnchor_retain (VuoAnchor value)
 Automatically generated function. More...
 
void VuoAnchor_release (VuoAnchor value)
 Automatically generated function. More...
 

Typedef Documentation

◆ VuoAnchor

typedef int64_t VuoAnchor

Combination vertical + horizontal alignment.

(VuoVerticalAlignment << 2) + VuoHorizontalAlignment

Definition at line 34 of file VuoAnchor.h.

Function Documentation

◆ VuoAnchor_areEqual()

bool VuoAnchor_areEqual ( const VuoAnchor  value1,
const VuoAnchor  value2 
)

Returns true if the two values are equal.

Definition at line 142 of file VuoAnchor.c.

◆ VuoAnchor_getAllowedValues()

VuoList_VuoAnchor VuoAnchor_getAllowedValues ( void  )

Returns a list of values that instances of this type can have.

Definition at line 110 of file VuoAnchor.c.

◆ VuoAnchor_getHorizontal()

static VuoHorizontalAlignment VuoAnchor_getHorizontal ( VuoAnchor  anchor) const
inlinestatic

Returns the horizontal component of a VuoAnchor.

Definition at line 54 of file VuoAnchor.h.

◆ VuoAnchor_getJson()

struct json_object * VuoAnchor_getJson ( const VuoAnchor  value)

Encodes value as a JSON object.

Definition at line 74 of file VuoAnchor.c.

◆ VuoAnchor_getOffset()

VuoPoint2d VuoAnchor_getOffset ( VuoAnchor  anchor)

Returns an offset (-.5, 0, or .5) for each axis of the anchor.

Changed in Vuo 2.0.0:
New.

Definition at line 129 of file VuoAnchor.c.

◆ VuoAnchor_getString()

char* VuoAnchor_getString ( const VuoAnchor  value)

Automatically generated function.

◆ VuoAnchor_getSummary()

char * VuoAnchor_getSummary ( const VuoAnchor  value)

Returns a compact string representation of value.

Definition at line 90 of file VuoAnchor.c.

◆ VuoAnchor_getVertical()

static VuoVerticalAlignment VuoAnchor_getVertical ( VuoAnchor  anchor) const
inlinestatic

Returns the horizontal component of a VuoAnchor.

Definition at line 63 of file VuoAnchor.h.

◆ VuoAnchor_isLessThan()

bool VuoAnchor_isLessThan ( const VuoAnchor  value1,
const VuoAnchor  value2 
)

Returns true if the value1 is less than value2.

Definition at line 151 of file VuoAnchor.c.

◆ VuoAnchor_make()

static VuoAnchor VuoAnchor_make ( VuoHorizontalAlignment  horizontal,
VuoVerticalAlignment  vertical 
) const
inlinestatic

Returns a VuoAnchor with horizontal and vertical alignments.

Definition at line 45 of file VuoAnchor.h.

◆ VuoAnchor_makeCentered()

static VuoAnchor VuoAnchor_makeCentered ( void  ) const
inlinestatic

Returns a VuoAnchor with both horizontal and vertical alignments centered.

Definition at line 72 of file VuoAnchor.h.

◆ VuoAnchor_makeFromJson()

VuoAnchor VuoAnchor_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
"center-top"
Example:
{
"verticalAlignment": "top",
"horizontalAlignment": "center",
}

Definition at line 46 of file VuoAnchor.c.

◆ VuoAnchor_makeFromString()

VuoAnchor VuoAnchor_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoAnchor_release()

void VuoAnchor_release ( VuoAnchor  value)

Automatically generated function.

◆ VuoAnchor_retain()

void VuoAnchor_retain ( VuoAnchor  value)

Automatically generated function.