Class MeshTorus

Generate a Torus with a given thickness and the number of major- and minor segments

Authors

Simon Storl-Schulke, HFU, 2020 | Jirka Dell'Oro-Friedl, HFU, 2020

Hierarchy (view full)

MeshRotation
- MeshTorus

Constructors

constructor

new MeshTorus(_name?, _size?, _longitudes?, _latitudes?): MeshTorus
Parameters
- _name: string = "MeshTorus"
- _size: number = 0.25
- _longitudes: number = 8
- _latitudes: number = 6
Returns MeshTorus
Overrides MeshRotation.constructor
- Defined in Core/Source/Mesh/MeshTorus.ts:11

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 MeshRotation.boundingBox
- Defined in Core/Source/Mesh/Mesh.ts:49

radius

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

renderMesh

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

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 MeshRotation.type
- Defined in Core/Source/Serialization/Mutable.ts:73

Methods

addEventListener

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

clear

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

Returns void
Inherited from MeshRotation.clear
- Defined in Core/Source/Mesh/Mesh.ts:84

create

create(_size?, _longitudes?, _latitudes?): void
Create this torus from the given parameters
Parameters
- _size: number = 0.25
- _longitudes: number = 8
- _latitudes: number = 6
Returns void
- Defined in Core/Source/Mesh/MeshTorus.ts:32

deserialize

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

dispatchEvent

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

getMutator

getMutator(_extendable?): 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 MeshRotation.getMutator
- Defined in Core/Source/Serialization/Mutable.ts:81

getMutatorAttributeTypes

getMutatorAttributeTypes(_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!
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from MeshRotation.getMutatorAttributeTypes
- Defined in Core/Source/Serialization/Mutable.ts:137

getMutatorForAnimation

getMutatorForAnimation(): 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

Returns MutatorForAnimation
Inherited from MeshRotation.getMutatorForAnimation
- Defined in Core/Source/Serialization/Mutable.ts:116

getMutatorForUserInterface

getMutatorForUserInterface(): 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

Returns MutatorForUserInterface
Inherited from MeshRotation.getMutatorForUserInterface
- Defined in Core/Source/Serialization/Mutable.ts:123

mutate

mutate(_mutator, _selection?, _dispatchMutate?): 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 MeshRotation.mutate
- Defined in Core/Source/Mesh/MeshTorus.ts:53

removeEventListener

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

serialize

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

Returns Serialization
Overrides MeshRotation.serialize
- Defined in Core/Source/Mesh/MeshTorus.ts:40

updateMutator

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

`Static` getMutatorFromPath

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

Class MeshTorus

Authors

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MeshTorus

Properties

faces

idResource

name

vertices

Static Readonly baseClass

Static Readonly iSubclass

Static Readonly subclasses

Accessors

boundingBox

Returns Box

radius

Returns number

renderMesh

Returns RenderMesh

type

Returns string

Methods

addEventListener

Parameters

Returns void

clear

Returns void

create

Parameters

Returns void

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

getMutator

Parameters

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Returns MutatorForAnimation

getMutatorForUserInterface

Returns MutatorForUserInterface

mutate

Parameters

Returns Promise<void>

removeEventListener

Parameters

Returns void

serialize

Returns Serialization

updateMutator

Parameters

Returns void

Static getMutatorFromPath

Parameters

Returns Mutator

Settings

Member Visibility

Theme

On This Page

`Static` `Readonly` baseClass

`Static` `Readonly` iSubclass

`Static` `Readonly` subclasses

`Static` getMutatorFromPath