Documentation

PointCloudMetadata
in package
implements ModelInterface, ArrayAccess, JsonSerializable

PointCloudMetadata Class Doc Comment

Tags
category

Class

description

Present when the version is a point cloud: the effective format settings (PointCloudFormatSettings: defaults + detection + the upload's overrides, plus detection warnings), the format, and what the 3D viewer navigates and measures by. Lengths are mm, positions in the model frame of the other bounds. Check-ins before recordVersion 2 have only the settings and the format; the viewer then estimates what it needs, and a reindex fills the rest in.

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
getFormat()  : InputFileType|null
Gets format
getModelName()  : string
The original name of the model.
getOutlierShare()  : float|null
Gets outlier_share
getRecordVersion()  : int|null
Gets record_version
getRobustBounds()  : BoundingBox|null
Gets robust_bounds
getScans()  : array<string|int, PointCloudScan>|null
Gets scans
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
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
setFormat()  : self
Sets format
setOutlierShare()  : self
Sets outlier_share
setRecordVersion()  : self
Sets record_version
setRobustBounds()  : self
Sets robust_bounds
setScans()  : self
Sets scans
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
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 = ['format' => 'format', 'record_version' => 'recordVersion', 'robust_bounds' => 'robustBounds', 'outlier_share' => 'outlierShare', 'scans' => 'scans']

$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 = ['format' => 'getFormat', 'record_version' => 'getRecordVersion', 'robust_bounds' => 'getRobustBounds', 'outlier_share' => 'getOutlierShare', 'scans' => 'getScans']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['format' => null, 'record_version' => null, 'robust_bounds' => null, 'outlier_share' => 'double', 'scans' => 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 = 'PointCloudMetadata'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['format' => false, 'record_version' => false, 'robust_bounds' => false, 'outlier_share' => false, 'scans' => 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 = ['format' => '\BIMworks\Model\InputFileType', 'record_version' => 'int', 'robust_bounds' => '\BIMworks\Model\BoundingBox', 'outlier_share' => 'float', 'scans' => '\BIMworks\Model\PointCloudScan[]']

$setters

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

protected static array<string|int, string> $setters = ['format' => 'setFormat', 'record_version' => 'setRecordVersion', 'robust_bounds' => 'setRobustBounds', 'outlier_share' => 'setOutlierShare', 'scans' => 'setScans']

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>

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getOutlierShare()

Gets outlier_share

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

getRecordVersion()

Gets record_version

public getRecordVersion() : 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>

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>

setOutlierShare()

Sets outlier_share

public setOutlierShare(float|null $outlier_share) : self
Parameters
$outlier_share : float|null

The share of the points outside robustBounds, from 0 to 1

Return values
self

setRecordVersion()

Sets record_version

public setRecordVersion(int|null $record_version) : self
Parameters
$record_version : int|null

2 when each point's 16-byte record carries the number of its scan (1-255, the position in scans; 0 for none or beyond 255) in its last byte, and the octree's nodes their spacing. Absent in older check-ins, whose last byte means nothing.

Return values
self

setRobustBounds()

Sets robust_bounds

public setRobustBounds(BoundingBox|null $robust_bounds) : self
Parameters
$robust_bounds : BoundingBox|null

The box that holds the cloud but for its far stray points (reflections, sky noise): per axis, 0.1% of the points at each end may fall outside it, to the octree's finest counting cell. The viewer fits its views to this box; culling and sectioning keep the exact bounds (transformedBoundsMm).

Return values
self

setScans()

Sets scans

public setScans(array<string|int, PointCloudScan>|null $scans) : self
Parameters
$scans : array<string|int, PointCloudScan>|null

The file's scans, in file order, with where each scanner stood. Empty for a format without scans (LAS, LAZ, PLY, XYZ).

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>

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