Class MeshExtrusion

Generates an extrusion of a polygon by a series of transformations

                     ____
Polygon         ____╱╲   ╲                             y
Transform 0  → ╱ ╲__╲_╲___╲ ← Transform 2          z __│
(base)         ╲_╱__╱ ╱   ╱   (lid)                     ╲       
    Transform 1  →  ╲╱___╱                               x

Authors

Jirka Dell'Oro-Friedl, HFU, 2021-2022

Hierarchy (View Summary)

MeshPolygon
- MeshExtrusion

Constructors

constructor

new MeshExtrusion(
    _name?: string,
    _vertices?: Vector2[],
    _mtxTransforms?: Matrix4x4[],
    _fitTexture?: boolean,
): MeshExtrusion
Parameters
- _name: string = "MeshExtrusion"
- _vertices: Vector2[] = MeshPolygon.shapeDefault
- _mtxTransforms: Matrix4x4[] = MeshExtrusion.mtxDefaults
- _fitTexture: boolean = true
Returns MeshExtrusion
Overrides MeshPolygon.constructor
- Defined in Source/Core/Mesh/MeshExtrusion.ts:22

Properties

faces

faces: Face[] = []

idResource

idResource: string = undefined

name

name: string = "Mesh"

vertices

vertices: Vertices = ...

`Static` `Readonly`baseClass

baseClass: typeof Mesh = Mesh

refers back to this class from any subclass e.g. in order to find compatible other resources

`Static` `Readonly`iSubclass

iSubclass: number = ...

`Static` `Readonly`subclasses

subclasses: typeof Mesh[] = []

list of all the subclasses derived from this class, if they registered properly

Accessors

boundingBox

get boundingBox(): Box
Returns Box
Inherited from MeshPolygon.boundingBox
- Defined in Source/Core/Mesh/Mesh.ts:51

isSerializableResource

get isSerializableResource(): true
Returns true
Inherited from MeshPolygon.isSerializableResource
- Defined in Source/Core/Mesh/Mesh.ts:40

radius

get radius(): number
Returns number
Inherited from MeshPolygon.radius
- Defined in Source/Core/Mesh/Mesh.ts:57

renderMesh

get renderMesh(): RenderMesh
Returns RenderMesh
Inherited from MeshPolygon.renderMesh
- Defined in Source/Core/Mesh/Mesh.ts:44

type

get type(): string
Retrieves the type of this mutable subclass as the name of the runtime class

Returns string
The type of the mutable
Inherited from MeshPolygon.type
- Defined in Source/Core/Serialization/Mutable.ts:193

Methods

addEventListener

addEventListener(
    _type: string,
    _handler: EventListenerUnified,
    _options?: boolean | AddEventListenerOptions,
): void
See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional_options: boolean | AddEventListenerOptions
Returns void
Inherited from MeshPolygon.addEventListener
- Defined in Source/Core/Event/Event.ts:91

animate

animate(_mutator: AnimationMutator): void
Updates the property values of the instance according to the state of the animation mutator. Override to implement custom animation behavior.
Parameters
- _mutator: AnimationMutator
Returns void
Inherited from MeshPolygon.animate
- Defined in Source/Core/Serialization/Mutable.ts:329

clear

clear(): void
Clears the bounds of this mesh aswell as the buffers of the associated RenderMesh.

Returns void
Inherited from MeshPolygon.clear
- Defined in Source/Core/Mesh/Mesh.ts:86

create

create(_shape?: Vector2[], _fitTexture?: boolean): void
Create this mesh from the given vertices.
Parameters
- _shape: Vector2[] = []
- _fitTexture: boolean = true
Returns void
Inherited from MeshPolygon.create
- Defined in Source/Core/Mesh/MeshPolygon.ts:35

deserialize

deserialize(_serialization: Serialization): Promise<Serializable>
Recreates this instance of Serializable with the information from the given Serialization.
Parameters
- _serialization: Serialization
Returns Promise<Serializable>
Overrides MeshPolygon.deserialize
- Defined in Source/Core/Mesh/MeshExtrusion.ts:35

dispatchEvent

dispatchEvent(_event: EventUnified): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from MeshPolygon.dispatchEvent
- Defined in Source/Core/Event/Event.ts:105

getMetaAttributeTypes

getMetaAttributeTypes(): MetaAttributeTypes
Retrieves the specified attribute types from the metadata of this instance's class.

Returns MetaAttributeTypes
Inherited from MeshPolygon.getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:289

getMetadata

getMetadata(): Metadata
Retrieves the metadata of this instance's class.

Returns Metadata
Inherited from MeshPolygon.getMetadata
- Defined in Source/Core/Serialization/Mutable.ts:296

getMutator

getMutator(_extendable?: boolean): Mutator
Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.
Parameters
- _extendable: boolean = false
Returns Mutator
Inherited from MeshPolygon.getMutator
- Defined in Source/Core/Serialization/Mutable.ts:202

getMutatorAttributeTypes

getMutatorAttributeTypes(_mutator: Mutator): MutatorAttributeTypes
Returns an associative array with the same attributes as the given mutator, but with the corresponding types as string-values. Does not recurse into objects! This will return the decorated meta-type instead of the runtime-type of the object, if available.
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from MeshPolygon.getMutatorAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:260

getMutatorForAnimation

getMutatorForAnimation(_extendable?: boolean): MutatorForAnimation
Collect the attributes of the instance and their values applicable for animation. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForAnimation
Inherited from MeshPolygon.getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:237

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?: boolean): MutatorForUserInterface
Collect the attributes of the instance and their values applicable for the user interface. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForUserInterface
Inherited from MeshPolygon.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:245

mutate

mutate(
    _mutator: Mutator,
    _selection?: string[],
    _dispatchMutate?: boolean,
): Promise<void>
Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses
Parameters
- _mutator: Mutator
- _selection: string[] = null
- _dispatchMutate: boolean = true
Returns Promise<void>
Overrides MeshPolygon.mutate
- Defined in Source/Core/Mesh/MeshExtrusion.ts:44

removeEventListener

removeEventListener(
    _type: string,
    _handler: EventListenerUnified,
    _options?: boolean | AddEventListenerOptions,
): void
See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional_options: boolean | AddEventListenerOptions
Returns void
Inherited from MeshPolygon.removeEventListener
- Defined in Source/Core/Event/Event.ts:98

serialize

serialize(): Serialization
Returns a Serialization of this object.

Returns Serialization
Overrides MeshPolygon.serialize
- Defined in Source/Core/Mesh/MeshExtrusion.ts:29

updateMutator

updateMutator(_mutator: Mutator): void
Updates the values of the given mutator according to the current state of the instance
Parameters
- _mutator: Mutator
Returns void
Inherited from MeshPolygon.updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:304

`Static`getMutatorFromPath

getMutatorFromPath(_mutator: Mutator, _path: string[]): Mutator
Decorator allows to attach Mutable functionality to existing classes.
Parameters
- _mutator: Mutator
- _path: string[]
Returns Mutator
Inherited from MeshPolygon.getMutatorFromPath
- Defined in Source/Core/Serialization/Mutable.ts:178

Class MeshExtrusion

Authors

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MeshExtrusion

Properties

faces

idResource

name

vertices

Static ReadonlybaseClass

Static ReadonlyiSubclass

Static Readonlysubclasses

Accessors

boundingBox

Returns Box

isSerializableResource

Returns true

radius

Returns number

renderMesh

Returns RenderMesh

type

Returns string

Methods

addEventListener

Parameters

Returns void

animate

Parameters

Returns void

clear

Returns void

create

Parameters

Returns void

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getMutator

Parameters

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Parameters

Returns MutatorForAnimation

getMutatorForUserInterface

Parameters

Returns MutatorForUserInterface

mutate

Parameters

Returns Promise<void>

removeEventListener

Parameters

Returns void

serialize

Returns Serialization

updateMutator

Parameters

Returns void

StaticgetMutatorFromPath

Parameters

Returns Mutator

Settings

`Static` `Readonly`baseClass

`Static` `Readonly`iSubclass

`Static` `Readonly`subclasses

`Static`getMutatorFromPath