Struct omf::BlockModel

pub struct BlockModel {
    pub orient: Orient3,
    pub grid: Grid3,
    pub subblocks: Option<Subblocks>,
}

Block model geometry with optional sub-blocks.

First, the orient field defines the position and orientation of a (U, V, W) space relative to the project, which could be just an offset or a full rotation as well. Then the grid field defines the size and number of parent blocks aligned with that space and starting at (0, 0, 0). Sub-blocks can then optionally be added inside those parent blocks using a variety of layouts.

While sub-blocks are supported on tensor grids it isn’t a common arrangement and many applications won’t load them.

Attribute Locations

• Vertices puts attribute values on the corners of the parent blocks. If the block count is $(N_0, N_1, N_2)$ then there must be $(N_0 + 1) · (N_1 + 1) · (N_2 + 1)$ values. Ordering increases U first, then V, then W.

• Blocks puts attribute values on the centroids of the parent block. If the block count is $(N_0, N_1, N_2)$ then there must be $N_0 · N_1 · N_2$ values. Ordering increases U first, then V, then W.

• Subblocks puts attribute values on sub-block centroids. The number and values and their ordering matches the parents and corners arrays.

  To have attribute values on undivided parent blocks in this mode there must be a sub-block that covers the whole parent block.

Fields

orient: Orient3

Orientation of the block model.

grid: Grid3

Block sizes.

subblocks: Option<Subblocks>

Optional sub-blocks, which can be regular or free-form divisions of the parent blocks.

Implementations

impl BlockModel

pub fn new(orient: Orient3, grid: Grid3) -> Self

pub fn with_subblocks( orient: Orient3, grid: Grid3, subblocks: Subblocks, ) -> Self

pub fn with_regular_subblocks( orient: Orient3, grid: Grid3, subblock_count: [u32; 3], subblocks: Array<RegularSubblock>, mode: Option<SubblockMode>, ) -> Self

pub fn with_freeform_subblocks( orient: Orient3, grid: Grid3, subblocks: Array<FreeformSubblock>, ) -> Self

pub fn has_subblocks(&self) -> bool

Returns true if the model has sub-blocks.

pub fn location_len(&self, location: Location) -> Option<u64>

Trait Implementations

impl Clone for BlockModel

fn clone(&self) -> BlockModel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockModel

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

Formats the value using the given formatter.

impl Default for BlockModel

fn default() -> BlockModel

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BlockModel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BlockModel> for Geometry

fn from(value: BlockModel) -> Self

Converts to this type from the input type.

impl JsonSchema for BlockModel

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for BlockModel

fn eq(&self, other: &BlockModel) -> 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 Serialize for BlockModel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for BlockModel

fn validate(&mut self) -> Result<Problems, Problems>

Call to validate the object, returning errors and warnings.

impl StructuralPartialEq for BlockModel