Struct Block 

pub struct Block { /* private fields */ }

A single block placed at a 3D lattice position in a BlockGraph.

Examples

use bloq_graph::{Block, BlockKind, CubeKind};
use glam::IVec3;

let block = Block::new(IVec3::ZERO, BlockKind::Cube(CubeKind::ZXZ)).with_tag("entry")?;
assert_eq!(block.pos(), IVec3::ZERO);
assert_eq!(block.kind(), BlockKind::Cube(CubeKind::ZXZ));
assert_eq!(block.tag(), Some("entry"));

Implementations

impl Block

pub fn new(pos: impl Into<IVec3>, kind: impl Into<BlockKind>) -> Self

Create an untagged block.

pub fn pos(&self) -> IVec3

Returns the block’s anchor position.

pub fn kind(&self) -> BlockKind

Returns the block kind.

pub fn height(&self) -> CubeHeight

Returns the symbolic cube height, always CubeHeight::DEFAULT for non-cube kinds.

pub fn height_cells(&self) -> u32

Returns how many lattice cells the block occupies along the time axis: the footprint half of height, driving positioning, occupancy, connectivity and visualization. Not the compiled round count (CubeHeight::rounds) — height=d/2 occupies one cell but compiles to ceil(d/2) rounds.

pub fn with_height(self, height: CubeHeight) -> Result<Self, BlockError>

Returns the block with its cube height set to height.

Errors

Returns a BlockError if the block is not a cube, or if the resulting footprint leaves the coordinate range.

pub fn port_color(&self) -> Option<RGBA>

Returns this Port’s display color, or None for non-Ports.

pub fn with_port_color(self, rgb: [u8; 3]) -> Result<Self, BlockError>

Sets this Port’s RGB display color. Alpha stays fixed and default gray is omitted from serialization.

Errors

Returns BlockError::PortColorOnNonPort for a non-Port block.

pub fn port_role(&self) -> Option<PortRole>

Returns this Port’s assigned direction, or None for non-Ports.

pub fn with_port_role(self, role: PortRole) -> Result<Self, BlockError>

Assigns this Port’s role.

Errors

Returns BlockError::PortRoleOnNonPort if this is not a Port block.

pub fn tag(&self) -> Option<&str>

Returns the nonempty user tag, if present.

pub fn with_tag(self, tag: impl Into<String>) -> Result<Self, BlockGraphError>

Returns the block tagged with tag. An empty tag clears the tag.

Errors

Returns BlockGraphError::InvalidTag unless tag is empty or satisfies is_valid_tag; an invalid tag would not survive a to_blog_text round-trip.

pub fn with_shift(&self, offset: impl Into<IVec3>) -> Self

Returns a copy of the block translated by offset.

Panics

Panics if the translated footprint exceeds the coordinate range. Use try_with_shift for untrusted offsets.

pub fn try_with_shift( &self, offset: impl Into<IVec3>, ) -> Result<Self, BlockGraphError>

Returns a copy of the block translated by offset.

Errors

Returns BlockGraphError::CoordinateOverflow if any translated footprint cell exceeds the coordinate range.

pub fn reserved_offsets(&self) -> SmallVec<[IVec3; 2]>

Returns every cell the block occupies, as offsets from its position.

A cube reserves one cell per height cell; other kinds defer to BlockKind::reserved_offsets.

pub fn connectable_offsets(&self) -> SmallVec<[IVec3; 2]>

Returns the cells that can host pipe connections, as offsets from the block position.

A multi-cell cube exposes its bottom and top cells; other kinds defer to BlockKind::connectable_offsets.

pub fn occupies_layer(&self, z: i32) -> bool

Returns whether the block reserves any cell in time layer z.

pub fn bases_at_endpoint(&self, endpoint: IVec3) -> Option<[Basis; 3]>

Returns the boundary bases exposed at the connectable endpoint, or None if the block exposes no endpoint there.

pub fn endpoint_for_direction(&self, dir: Direction) -> IVec3

Returns the exposed connectable endpoint facing dir.

Multi-span blocks can reserve interior cells that are not valid external endpoints; for example a multi-cell cube resolves +Z to its top cell.

Trait Implementations

impl Clone for Block

fn clone(&self) -> Block

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl Default for Block

fn default() -> Self

Returns the “default value” for a type.

impl Display for Block

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

Formats the value using the given formatter.

impl Eq for Block

impl Hash for Block

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 Ord for Block

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Block

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Block

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Block