globals(3U)

💖 globals(3U) — the Unidraw girlies' shared stuff 💖

okay so bestie, welcome to globals, part of the InterViews Reference Manual ✨ this is the Unidraw page that's literally the group chat of the whole library — all the constants, types, one-of-a-kind instances, and lil helper functions that everybody keeps referencing. 🫶

✨ SYNOPSIS ✨

#include <Unidraw/globals.h>

🌸 DESCRIPTION 🌸

So there are several constants and types that get used all over the place throughout the Unidraw library — like, everywhere, no cap. This page also hands you global access to the one-of-a-kind instances (hi, the unidraw object 👋) plus the shared graphics resources. And finally there's a lil collection of global functions for common data manipulations. 💅

The way that all of these are declared in one file so you can just include it wherever you need them? Iconic. Efficient. Periodt.

🎀 CONSTANTS 🎀

• static const int CHARBUFSIZE — the size of the standard character buffer. 📏
• static const int HANDLE_SIZE — the size of selection handles, in pixels. Those lil grabby bits, yk?
• static const char MARK[] — a string that delineates data boundaries in the ASCII representation that Catalog generates. It's used for error checking, so it's giving hall monitor energy but make it helpful. 🚨
• static const int PIN_RAD — the radius of a pin, used in its default graphical representation, in pixels. 📍
• static const int SLOP — the tolerance within which a hit on a graphical object will be detected, in pixels. Basically the "close enough bestie" radius. 🎯

🦋 TYPES 🦋

• enum DragConstraint — enumerates the orthogonal ways cursor movement may be constrained, usually during direct manipulation. Possible values include None, XFixed, YFixed, XYEqual, HorizOrVert, or Gravity. Pick your fighter. 🥊
• enum Mobility — enumerates the three possible component mobilities: Fixed, Floating, or Undef (undefined).
• typedef unsigned Orientation — specifies two kinds of orientation: Portrait or Vertical (synonymous 💞), and Landscape or Horizontal (also synonymous 💞).
• enum TransMethod — enumerates the three possible transmission methods for connectors: In, Out, or InOut.
• typedef unsigned long ClassId — the type for representing unique class names for catalog-managed objects. 🏷️

👑 INSTANCES 👑

extern Unidraw* unidraw
extern CSolver* csolver

The global unidraw and csolver objects. And here's the best part — these and all other global instances are initialized automatically. ✨ no manual setup, we love a low-maintenance king.

extern PSColor* psblack
extern PSColor* pswhite
extern PSPattern* pssolid
extern PSPattern* psclear
extern PSPattern* psnonepat
extern PSBrush* pssingle
extern PSBrush* psnonebr
extern PSFont* psstdfont

Predefined graphics resource objects. 🎨 fyi the None operation on psnonepat and psnonebr returns true.

extern Graphic* stdgraphic

A FullGraphic instance with its graphics state set to the global values listed above — excluding psnonepat and psnonebr. 🙈 not them.

💅 FUNCTIONS 💅

extern void NormalRect(Coord& l, Coord& b, Coord& r, Coord& t)

Given two coordinate pairs (l, b) and (r, t), it checks whether l < r and b < t. If not, it swaps the values in the offending inequalities. 🔄 This function is useful for ensuring that a rectangle is defined by its lower-left and upper-right vertices. Basically it fixes your rectangle's whole vibe so it's actually right-side up.

extern void GetLine(
    const char* buf, int len, int beg, int& end,
    int& size, int& nextBeg
)

This function is convenient for extracting lines from a buffer with a minimum of additional math operations — say less, we hate extra math. 🧮

Given a buffer of characters buf of length len, search for the first newline character (or the last character in the buffer) after the character at index beg. Then it returns:

• the newline's position in end
• the size of the run of text terminated by a newline, which is end + 1 - beg, in size
• the index with which to begin a search for the next newline character, in nextBeg

extern void GetAlignmentPoint(
    Graphic*, Alignment, float&, float&
)

Return the point (in floating point canvas coordinates) on a graphic corresponding to the given alignment. For example, to obtain the coordinates of the lower-left of a rectangle graphic, specify the graphic and a BottomLeft alignment. 📐 obsessed.

extern void Ref(Resource*)

Call the Reference operation on the given instance of a resource subclass — if the pointer is non-nil. (so if it's nil, nothing happens, it's giving "seen at 11:47 pm" 💀)

extern char* strnew(const char*)

Duplicate the given null-terminated string, creating a buffer of the appropriate size and returning the null-terminated result. 💖 a lil dupe, but make it legal.

🌈 SEE ALSO 🌈

CSolver(3U), Catalog(3U), Graphic(3U), GraphicView(3U), Pin(3U), Resource(3I), Unidraw(3U), InterViews(3I), pspaint(3U)

and that's the whole page bestie, go forth and globals responsibly 🫶

Unidraw · 30 July 1990 — yeah she's vintage, she's a classic, she's got main character energy from nineteen ninety and she still slays. 💜⭐