Struct Text 

pub struct Text { /* private fields */ }

A piece of text rendered as voxels.

Each Text contains:

• A string, as ArcStr.
• A Font.
• Blocks defining voxel colors and attributes used.
• A Resolution defining the font size.
• A bounding box within which the text is positioned (but may overflow).
• A Positioning specifying how the text is positioned within the box.

To create a block or multiblock group from this, use Primitive::Text. To combine the text with other shapes, use Modifier::Composite.

Implementations

impl Text

pub fn builder() -> TextBuilder

Returns a TextBuilder which may be used to construct a Text value with explicit or default options.

pub fn into_builder(self) -> TextBuilder

Converts this into a TextBuilder so that it may be modified.

pub fn string(&self) -> &ArcStr

Returns the string which this displays.

pub fn font(&self) -> &Font

Returns the font which this uses to display the text.

pub fn resolution(&self) -> &Font

Returns the voxel resolution which the text blocks will have.

pub fn layout_bounds(&self) -> GridAab

Returns the bounding box, within the blocks at the specified resolution, of the text.

This does not reflect the actual size of the text but the configuration with which this Text value was constructed. The text may overflow this bounding box depending on its length and the positioning().

pub fn positioning(&self) -> Positioning

Returns the Positioning parameters this uses.

pub fn debug(&self) -> bool

Returns the debug-rendering flag.

pub fn bounding_voxels(&self) -> GridAab

Returns the bounding box of the text as displayed, in voxels at the resolution().

This box is in the same units as Self::layout_bounds() but reflects the actual text layout rather than the configuration.

pub fn bounding_blocks(&self) -> GridAab

Returns the bounding box of the text, in blocks — the set of Primitive::Text offsets that will render all of it.

This is identical to Self::bounding_voxels() scaled down by Self::resolution().

pub fn installation( &self, transform: Gridgid, block_fn: impl Fn(Block) -> Block, ) -> SpaceTransaction

Returns a transaction which places Primitive::Text blocks containing this text.

The text lies within the volume Self::bounding_blocks() transformed by transform.

Each individual block is given to block_fn to allow alterations.

The transaction has no preconditions.

Panics if transform causes coordinate overflow.

pub fn single_block(self) -> Block

Returns a Block whose primitive is this text with no offset, for quickly creating blocks from text that fits in one block.

Trait Implementations

impl<'a> Arbitrary<'a> for Text

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Text

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Text

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Text

fn eq(&self, other: &Text) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VisitHandles for Text

fn visit_handles(&self, visitor: &mut dyn HandleVisitor)

For each Handle contained within self that is reachable without traversing another Handle, call visitor with a reference to it.

impl Eq for Text

impl StructuralPartialEq for Text