Documentation

ExportVectorSvgRequest
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ExportVectorSvgRequest Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

CACHE__USE  : mixed = 'use'
CACHE_BYPASS  : mixed = 'bypass'
CACHE_REFRESH  : mixed = 'refresh'
DISCRIMINATOR  : mixed = null
VIEW_BACK  : mixed = 'back'
VIEW_BOTTOM  : mixed = 'bottom'
VIEW_FRONT  : mixed = 'front'
VIEW_LEFT  : mixed = 'left'
VIEW_RIGHT  : mixed = 'right'
VIEW_TOP  : mixed = 'top'

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
getCache()  : string|null
Gets cache
getCacheAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCut()  : float|null
Gets cut
getCutFraction()  : float|null
Gets cut_fraction
getDirection()  : Vector3|null
Gets direction
getHairline()  : bool|null
Gets hairline
getJitter()  : int|null
Gets jitter
getLabels()  : LabelSettings|null
Gets labels
getModel()  : ModelIdentifier
Gets model
getModelName()  : string
The original name of the model.
getSize()  : int|null
Gets size
getStyling()  : ObjectStyling|null
Gets styling
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getView()  : string|null
Gets view
getViewAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
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
setCache()  : self
Sets cache
setCut()  : self
Sets cut
setCutFraction()  : self
Sets cut_fraction
setDirection()  : self
Sets direction
setHairline()  : self
Sets hairline
setJitter()  : self
Sets jitter
setLabels()  : self
Sets labels
setModel()  : self
Sets model
setSize()  : self
Sets size
setStyling()  : self
Sets styling
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setView()  : self
Sets view
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 = ['view' => 'view', 'direction' => 'direction', 'cut' => 'cut', 'cut_fraction' => 'cut_fraction', 'size' => 'size', 'jitter' => 'jitter', 'hairline' => 'hairline', 'model' => 'model', 'styling' => 'styling', 'labels' => 'labels', 'cache' => 'cache']

$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 = ['view' => 'getView', 'direction' => 'getDirection', 'cut' => 'getCut', 'cut_fraction' => 'getCutFraction', 'size' => 'getSize', 'jitter' => 'getJitter', 'hairline' => 'getHairline', 'model' => 'getModel', 'styling' => 'getStyling', 'labels' => 'getLabels', 'cache' => 'getCache']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['view' => null, 'direction' => null, 'cut' => 'double', 'cut_fraction' => 'double', 'size' => null, 'jitter' => null, 'hairline' => null, 'model' => null, 'styling' => null, 'labels' => null, 'cache' => 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 = 'ExportVectorSvgRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['view' => false, 'direction' => false, 'cut' => false, 'cut_fraction' => false, 'size' => false, 'jitter' => false, 'hairline' => false, 'model' => false, 'styling' => false, 'labels' => false, 'cache' => 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 = ['view' => 'string', 'direction' => '\BIMworks\Model\Vector3', 'cut' => 'float', 'cut_fraction' => 'float', 'size' => 'int', 'jitter' => 'int', 'hairline' => 'bool', 'model' => '\BIMworks\Model\ModelIdentifier', 'styling' => '\BIMworks\Model\ObjectStyling', 'labels' => '\BIMworks\Model\LabelSettings', 'cache' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['view' => 'setView', 'direction' => 'setDirection', 'cut' => 'setCut', 'cut_fraction' => 'setCutFraction', 'size' => 'setSize', 'jitter' => 'setJitter', 'hairline' => 'setHairline', 'model' => 'setModel', 'styling' => 'setStyling', 'labels' => 'setLabels', 'cache' => 'setCache']

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>

getCacheAllowableValues()

Gets allowable values of the enum

public getCacheAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getCutFraction()

Gets cut_fraction

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getters()

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

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

getViewAllowableValues()

Gets allowable values of the enum

public getViewAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

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>

setCache()

Sets cache

public setCache(string|null $cache) : self
Parameters
$cache : string|null

Consult the drawing cache (use), skip it (bypass) or replace its entry (refresh).

Return values
self

setCut()

Sets cut

public setCut(float|null $cut) : self
Parameters
$cut : float|null

Cut plane in world millimetres along the view direction; geometry on the camera side is removed. A storey elevation plus 1100 is that storey's floor plan.

Return values
self

setCutFraction()

Sets cut_fraction

public setCutFraction(float|null $cut_fraction) : self
Parameters
$cut_fraction : float|null

Cut as a fraction through the bulk of the visible geometry (0.5 = mid height); resolved to millimetres server-side.

Return values
self

setHairline()

Sets hairline

public setHairline(bool|null $hairline) : self
Parameters
$hairline : bool|null

Every line one screen pixel wide at any zoom (vector-effect non-scaling-stroke) instead of a width relative to the drawing.

Return values
self

setJitter()

Sets jitter

public setJitter(int|null $jitter) : self
Parameters
$jitter : int|null

Jittered passes of the visibility raster.

Return values
self

setSize()

Sets size

public setSize(int|null $size) : self
Parameters
$size : int|null

Resolution of the visibility raster.

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>

setView()

Sets view

public setView(string|null $view) : self
Parameters
$view : string|null

view

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