Documentation

ImMetadata
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ImMetadata Class Doc Comment

Tags
category

Class

description

Metadata of the indexed model (derivative set) belonging to a Version. This is the viewer contract: a Version can be passed to the Viewer3D/Viewer2D ModelManager once im_metadata is present. It is null while the model is still being processed (or when processing failed) — poll getVersion until it appears. All fields the viewers read are listed explicitly; additional fields may be present.

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR  : mixed = null

Properties

$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string|int, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, bool>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)

Methods

__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getAnchorPoint()  : Vector3|null
Gets anchor_point
getBaseTranslation()  : Vector3|null
Gets base_translation
getFilename()  : string|null
Gets filename
getFilesize()  : int|null
Gets filesize
getFilesizeEstimated()  : bool|null
Gets filesize_estimated
getGeometryType()  : string|null
Gets geometry_type
getGeoReference()  : GeoReference|null
Gets geo_reference
getGlobalTranslationVector()  : Vector3|null
Gets global_translation_vector
getIfcSchema()  : string|null
Gets ifc_schema
getMid()  : string|null
Gets mid
getModelName()  : string
The original name of the model.
getMultiplierToMm()  : float|null
Gets multiplier_to_mm
getNrOfPrimitives()  : int|null
Gets nr_of_primitives
getObbMm()  : OrientedBoundingBox|null
Gets obb_mm
getPointCloud()  : PointCloudMetadata|null
Gets point_cloud
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTotalBounds()  : BoundingBox|null
Gets total_bounds
getTransformedBoundsMm()  : BoundingBox|null
Gets transformed_bounds_mm
getTransformedMainBoundsMm()  : BoundingBox|null
Gets transformed_main_bounds_mm
getUntransformedBoundsMm()  : BoundingBox|null
Gets untransformed_bounds_mm
getVertexUnquantizationMatrix()  : array<string|int, float>|null
Gets vertex_unquantization_matrix
isNullable()  : bool
Checks if a property is nullable
isNullableSetToNull()  : bool
Checks if a nullable property is set to null.
jsonSerialize()  : mixed
Serializes the object to a value that can be serialized natively by json_encode().
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed|null
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
openAPIFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
setAnchorPoint()  : self
Sets anchor_point
setBaseTranslation()  : self
Sets base_translation
setFilename()  : self
Sets filename
setFilesize()  : self
Sets filesize
setFilesizeEstimated()  : self
Sets filesize_estimated
setGeometryType()  : self
Sets geometry_type
setGeoReference()  : self
Sets geo_reference
setGlobalTranslationVector()  : self
Sets global_translation_vector
setIfcSchema()  : self
Sets ifc_schema
setMid()  : self
Sets mid
setMultiplierToMm()  : self
Sets multiplier_to_mm
setNrOfPrimitives()  : self
Sets nr_of_primitives
setObbMm()  : self
Sets obb_mm
setPointCloud()  : self
Sets point_cloud
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTotalBounds()  : self
Sets total_bounds
setTransformedBoundsMm()  : self
Sets transformed_bounds_mm
setTransformedMainBoundsMm()  : self
Sets transformed_main_bounds_mm
setUntransformedBoundsMm()  : self
Sets untransformed_bounds_mm
setVertexUnquantizationMatrix()  : self
Sets vertex_unquantization_matrix
toHeaderValue()  : string
Gets a header-safe presentation of the object
valid()  : bool
Validate all the properties in the model return true if all passed
openAPINullables()  : array<string|int, mixed>
Array of nullable properties
getOpenAPINullablesSetToNull()  : array<string|int, bool>
Array of nullable field names deliberately set to null
setIfExists()  : void
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
setOpenAPINullablesSetToNull()  : void
Setter - Array of nullable field names deliberately set to null

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['mid' => 'mid', 'ifc_schema' => 'ifcSchema', 'filename' => 'filename', 'filesize' => 'filesize', 'filesize_estimated' => 'filesize_estimated', 'geometry_type' => 'geometryType', 'nr_of_primitives' => 'nrOfPrimitives', 'multiplier_to_mm' => 'multiplierToMm', 'transformed_bounds_mm' => 'transformedBoundsMm', 'transformed_main_bounds_mm' => 'transformedMainBoundsMm', 'untransformed_bounds_mm' => 'untransformedBoundsMm', 'total_bounds' => 'totalBounds', 'obb_mm' => 'obbMm', 'base_translation' => 'baseTranslation', 'global_translation_vector' => 'globalTranslationVector', 'anchor_point' => 'anchorPoint', 'vertex_unquantization_matrix' => 'vertexUnquantizationMatrix', 'geo_reference' => 'geoReference', 'point_cloud' => 'pointCloud']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['mid' => 'getMid', 'ifc_schema' => 'getIfcSchema', 'filename' => 'getFilename', 'filesize' => 'getFilesize', 'filesize_estimated' => 'getFilesizeEstimated', 'geometry_type' => 'getGeometryType', 'nr_of_primitives' => 'getNrOfPrimitives', 'multiplier_to_mm' => 'getMultiplierToMm', 'transformed_bounds_mm' => 'getTransformedBoundsMm', 'transformed_main_bounds_mm' => 'getTransformedMainBoundsMm', 'untransformed_bounds_mm' => 'getUntransformedBoundsMm', 'total_bounds' => 'getTotalBounds', 'obb_mm' => 'getObbMm', 'base_translation' => 'getBaseTranslation', 'global_translation_vector' => 'getGlobalTranslationVector', 'anchor_point' => 'getAnchorPoint', 'vertex_unquantization_matrix' => 'getVertexUnquantizationMatrix', 'geo_reference' => 'getGeoReference', 'point_cloud' => 'getPointCloud']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['mid' => 'uuid', 'ifc_schema' => null, 'filename' => null, 'filesize' => 'int64', 'filesize_estimated' => null, 'geometry_type' => null, 'nr_of_primitives' => 'int64', 'multiplier_to_mm' => null, 'transformed_bounds_mm' => null, 'transformed_main_bounds_mm' => null, 'untransformed_bounds_mm' => null, 'total_bounds' => null, 'obb_mm' => null, 'base_translation' => null, 'global_translation_vector' => null, 'anchor_point' => null, 'vertex_unquantization_matrix' => null, 'geo_reference' => null, 'point_cloud' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'ImMetadata'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['mid' => false, 'ifc_schema' => false, 'filename' => false, 'filesize' => false, 'filesize_estimated' => false, 'geometry_type' => false, 'nr_of_primitives' => false, 'multiplier_to_mm' => false, 'transformed_bounds_mm' => false, 'transformed_main_bounds_mm' => false, 'untransformed_bounds_mm' => false, 'total_bounds' => false, 'obb_mm' => false, 'base_translation' => false, 'global_translation_vector' => false, 'anchor_point' => false, 'vertex_unquantization_matrix' => false, 'geo_reference' => false, 'point_cloud' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string|int, bool> $openAPINullablesSetToNull = []

$openAPITypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $openAPITypes = ['mid' => 'string', 'ifc_schema' => 'string', 'filename' => 'string', 'filesize' => 'int', 'filesize_estimated' => 'bool', 'geometry_type' => 'string', 'nr_of_primitives' => 'int', 'multiplier_to_mm' => 'float', 'transformed_bounds_mm' => '\BIMworks\Model\BoundingBox', 'transformed_main_bounds_mm' => '\BIMworks\Model\BoundingBox', 'untransformed_bounds_mm' => '\BIMworks\Model\BoundingBox', 'total_bounds' => '\BIMworks\Model\BoundingBox', 'obb_mm' => '\BIMworks\Model\OrientedBoundingBox', 'base_translation' => '\BIMworks\Model\Vector3', 'global_translation_vector' => '\BIMworks\Model\Vector3', 'anchor_point' => '\BIMworks\Model\Vector3', 'vertex_unquantization_matrix' => 'float[]', 'geo_reference' => '\BIMworks\Model\GeoReference', 'point_cloud' => '\BIMworks\Model\PointCloudMetadata']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['mid' => 'setMid', 'ifc_schema' => 'setIfcSchema', 'filename' => 'setFilename', 'filesize' => 'setFilesize', 'filesize_estimated' => 'setFilesizeEstimated', 'geometry_type' => 'setGeometryType', 'nr_of_primitives' => 'setNrOfPrimitives', 'multiplier_to_mm' => 'setMultiplierToMm', 'transformed_bounds_mm' => 'setTransformedBoundsMm', 'transformed_main_bounds_mm' => 'setTransformedMainBoundsMm', 'untransformed_bounds_mm' => 'setUntransformedBoundsMm', 'total_bounds' => 'setTotalBounds', 'obb_mm' => 'setObbMm', 'base_translation' => 'setBaseTranslation', 'global_translation_vector' => 'setGlobalTranslationVector', 'anchor_point' => 'setAnchorPoint', 'vertex_unquantization_matrix' => 'setVertexUnquantizationMatrix', 'geo_reference' => 'setGeoReference', 'point_cloud' => 'setPointCloud']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed>|null $data = null ]) : mixed
Parameters
$data : array<string|int, mixed>|null = null

Associated array of property values initializing the model

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFilename()

Gets filename

public getFilename() : string|null
Return values
string|null

getFilesize()

Gets filesize

public getFilesize() : int|null
Return values
int|null

getFilesizeEstimated()

Gets filesize_estimated

public getFilesizeEstimated() : bool|null
Return values
bool|null

getGeometryType()

Gets geometry_type

public getGeometryType() : string|null
Return values
string|null

getGlobalTranslationVector()

Gets global_translation_vector

public getGlobalTranslationVector() : Vector3|null
Return values
Vector3|null

getIfcSchema()

Gets ifc_schema

public getIfcSchema() : string|null
Return values
string|null

getMid()

Gets mid

public getMid() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getMultiplierToMm()

Gets multiplier_to_mm

public getMultiplierToMm() : float|null
Return values
float|null

getNrOfPrimitives()

Gets nr_of_primitives

public getNrOfPrimitives() : int|null
Return values
int|null

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getVertexUnquantizationMatrix()

Gets vertex_unquantization_matrix

public getVertexUnquantizationMatrix() : array<string|int, float>|null
Return values
array<string|int, float>|null

isNullable()

Checks if a property is nullable

public static isNullable(string $property) : bool
Parameters
$property : string
Return values
bool

isNullableSetToNull()

Checks if a nullable property is set to null.

public isNullableSetToNull(string $property) : bool
Parameters
$property : string
Return values
bool

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int|string $offset) : bool
Parameters
$offset : int|string

Offset

Return values
bool

offsetGet()

Gets offset.

public offsetGet(int|string $offset) : mixed|null
Parameters
$offset : int|string

Offset

Attributes
#[ReturnTypeWillChange]
Return values
mixed|null

offsetSet()

Sets value based on offset.

public offsetSet(int|null $offset, mixed $value) : void
Parameters
$offset : int|null

Offset

$value : mixed

Value to be set

offsetUnset()

Unsets offset.

public offsetUnset(int|string $offset) : void
Parameters
$offset : int|string

Offset

openAPIFormats()

Array of property to format mappings. Used for (de)serialization

public static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

openAPITypes()

Array of property to type mappings. Used for (de)serialization

public static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

setAnchorPoint()

Sets anchor_point

public setAnchorPoint(Vector3|null $anchor_point) : self
Parameters
$anchor_point : Vector3|null

anchor_point

Return values
self

setBaseTranslation()

Sets base_translation

public setBaseTranslation(Vector3|null $base_translation) : self
Parameters
$base_translation : Vector3|null

base_translation

Return values
self

setFilename()

Sets filename

public setFilename(string|null $filename) : self
Parameters
$filename : string|null

The filename of the uploaded source model

Return values
self

setFilesize()

Sets filesize

public setFilesize(int|null $filesize) : self
Parameters
$filesize : int|null

The size of the source model in bytes

Return values
self

setFilesizeEstimated()

Sets filesize_estimated

public setFilesizeEstimated(bool|null $filesize_estimated) : self
Parameters
$filesize_estimated : bool|null

Whether filesize is an estimate (e.g. for TRANSACTION versions)

Return values
self

setGeometryType()

Sets geometry_type

public setGeometryType(string|null $geometry_type) : self
Parameters
$geometry_type : string|null

The type of the generated geometry (e.g. BASIC, OCTREE_CHUNKED)

Return values
self

setGeoReference()

Sets geo_reference

public setGeoReference(GeoReference|null $geo_reference) : self
Parameters
$geo_reference : GeoReference|null

geo_reference

Return values
self

setGlobalTranslationVector()

Sets global_translation_vector

public setGlobalTranslationVector(Vector3|null $global_translation_vector) : self
Parameters
$global_translation_vector : Vector3|null

global_translation_vector

Return values
self

setIfcSchema()

Sets ifc_schema

public setIfcSchema(string|null $ifc_schema) : self
Parameters
$ifc_schema : string|null

The IFC schema of the source model (e.g. IFC2X3, IFC4)

Return values
self

setMid()

Sets mid

public setMid(string|null $mid) : self
Parameters
$mid : string|null

The UUID of the indexed model, used by the viewer to fetch geometry

Return values
self

setMultiplierToMm()

Sets multiplier_to_mm

public setMultiplierToMm(float|null $multiplier_to_mm) : self
Parameters
$multiplier_to_mm : float|null

Multiplier to convert the model's length unit to millimeters

Return values
self

setNrOfPrimitives()

Sets nr_of_primitives

public setNrOfPrimitives(int|null $nr_of_primitives) : self
Parameters
$nr_of_primitives : int|null

The number of geometric primitives (triangles) in the model

Return values
self

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>

setTotalBounds()

Sets total_bounds

public setTotalBounds(BoundingBox|null $total_bounds) : self
Parameters
$total_bounds : BoundingBox|null

total_bounds

Return values
self

setTransformedBoundsMm()

Sets transformed_bounds_mm

public setTransformedBoundsMm(BoundingBox|null $transformed_bounds_mm) : self
Parameters
$transformed_bounds_mm : BoundingBox|null

transformed_bounds_mm

Return values
self

setTransformedMainBoundsMm()

Sets transformed_main_bounds_mm

public setTransformedMainBoundsMm(BoundingBox|null $transformed_main_bounds_mm) : self
Parameters
$transformed_main_bounds_mm : BoundingBox|null

transformed_main_bounds_mm

Return values
self

setUntransformedBoundsMm()

Sets untransformed_bounds_mm

public setUntransformedBoundsMm(BoundingBox|null $untransformed_bounds_mm) : self
Parameters
$untransformed_bounds_mm : BoundingBox|null

untransformed_bounds_mm

Return values
self

setVertexUnquantizationMatrix()

Sets vertex_unquantization_matrix

public setVertexUnquantizationMatrix(array<string|int, float>|null $vertex_unquantization_matrix) : self
Parameters
$vertex_unquantization_matrix : array<string|int, float>|null

Column-major 4x4 matrix (16 numbers) to unquantize vertex coordinates

Return values
self

toHeaderValue()

Gets a header-safe presentation of the object

public toHeaderValue() : string
Return values
string

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

openAPINullables()

Array of nullable properties

protected static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool>

setIfExists()

Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array

private setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string|int, bool>
On this page

Search results