User's Reference - LaTeXCaption

Category

Font Utilities

Function

Displays a LaTeX typeset caption on the screen.

Syntax


caption = LaTeXCaption(string, baseline, coords, priority,
                  position, height, preamble, reference);

Inputs

Name	Type	Default	Description
`latex_file`	string	none	file containing LaTeX directives
`baseline`	vector	[1 0 0]	direction of baseline
`coords`	string	"viewport"	"viewport", "pixel", "world"
`priority`	string	"in front"	"in front", "equal", "behind"
`position`	vector	[0 0 0]	screen position
`height`	integer	15	caption height (pixels)
`preamble`	string	NULL	LaTeX preamble text
`reference`	integer	[1–9]	reference point

Outputs

Name	Type	Description
`caption`	color field	LaTeX formatted string object that can be rendered

Functional Details

The caption produced is aligned in parallel with the screen.

`latex_file`	contains the caption to be displayed. This takes the form of ascii text interspersed with LaTeX directives.
`baseline`	specifies the direction of the baseline as a vector.
`coords`	determines the type of coordinates used in placing the caption: "viewport", "pixel" or "world".
`priority`	determines the display priority of the caption relative to other opendx objects: "in front"; "equal"; "behind".
position	position of text on screen (subject to coords parameter).
`height`	height of the caption characters in pixels. A negative value generates an inverted caption.
`preamble`	contains any LaTeX preamble commands.
reference	reference point for placement of output: (1) bottom left; (2) bottom centre; (3) bottom right; (4) centre left; (5) centre; (6) centre right; (7) top left; (8) top centre; (9) top right.

Notes:

To change the color of a caption, use the Color module.
If you are using Render or Display to render an object which contains a caption, when you change the resolution of the camera the size of the caption in pixels will not change. If you want the caption to take up the same proportion of the image, use the ScaleScreen module to change the size of the caption.
To antialias LaTeX formatted text, use TextAlias.
Requires ScreenObject module available from VIS Inc..

Components

Creates "positions," "connections," and "colors" components.

Example Visual Programs

Many example visual programs use Caption, including:

Example.net