AGRestrictedText / AGRestrictedTextObj

Synopsis

define text or an array of text strings bound to fit inside a given box

AGGeometryPrimitive+AGTextParams AGRestrictedText
{
     geometry+IPort2 = {0,0};
     font = "sw:roman-simplex";
     frameWidth = 0.25;
     text+IPort2[] = {"restricted text"};
     AGGeometry upVector = {0,0.3};
     AGGeometry baseVector = {2,0};
};

Description

AGRestrictedText and AGRestrictedTextObj define text that is constrained to the inside of a given parallelogram. The parameters baseVector and upVector define the parallelogram. AGRestrictedTextObj includes an AGDataObject for your convenience.

To plot more than one string, each string must have a corresponding XY pair in the geometry subobject.

Contrary to AGText and AGTransformableText, the frameWidth subobject defaults to a nonzero value. Therefore, a frame showing the bounding parallelogram is drawn by default. Set frameWidth to 0.0 to turn the frame off.

Subobjects

visibility

priority

Inherited from AGPrimitive through AGGeometryPrimitive.

geometry

Inherited from AGGeometryPrimitive.

text

color

font

fillColor

frameColor

frameWidth

horizontalJustification

verticalJustification

multiLineJustification

multiLineSpacingFactor

Inherited from AGTextParams. If the text subobject includes the newline character ("\n"), the text appears on multiple lines, but fits inside the given parallelogram.

upVector

baseVector

Two vectors that describe the bounding box of the restricted text. When connected to an AGDataObject, the transformation matrix in AGDataObject transforms the baseVector and upVector.

Example

Not Available

File

v/AG.v

See Also Related Modules

AGDataObject

AGGeometryPrimitive / AGRenderPrimitive

AGPrimitive

AGTextParams