Urchin Reference - MeshUrbject

A MeshUrbject is an Urbject that has a physical appearance by adapting a Mesh to its local transform and providing a Material to be used to render the Mesh.

A MeshUrbject is the only type of Urbject that has a physical appearance in the Scene.

See also: Urbject, Mesh, Material, Scene

Constructors

MeshUrbject( ): MeshUrbject

Initializes with default attribute values.

MeshUrbject( { mesh?: Mesh, material?: Material, position?: Vector, orientation?: Quaternion, scale?: number | Vector, state?: number, group?: number, superCopy?: Urbject } ): MeshUrbject

Initializes with the given values or default values if not provided. The default values are:

mesh	new Mesh()	An empty Mesh. See also: Mesh
material	new Material()	A default Material. See also: Material
position	Default from Urbject constructor	See also: Urbject
orientation	Default from Urbject constructor	See also: Urbject
scale	Default from Urbject constructor	See also: Urbject
state	Default from Urbject constructor	See also: Urbject
group	Default from Urbject constructor	See also: Urbject
superCopy	Default from Urbject constructor	See also: Urbject

Variables

Public Variables

material: Material	The Material that will be used to render this Urbject's Mesh. See also: Material
mesh: Mesh	The Mesh that will be transformed and rendered as a part of this Urbject. See also: Mesh

Functions

Public Functions

copy(options?: { shallow: boolean } ): MeshUrbject	Returns a copy of the MeshUrbject. If shallow is true, the children of this Urbject will not be included in the copy.
getInstance(camera: Camera): FrameInstance	Returns the FrameInstance of this Urbject with all of its Trigon Fragments added. See also: Urbject, FrameInstance, Trigon, Fragment

Static Functions

MeshUrbject.copy(u: MeshUrbject, options?: { shallow: boolean } ): MeshUrbject	Returns a copy of the MeshUrbject or a new MeshUrbject from an Object with all of the necessary MeshUrbject and Urbject public attributes. If shallow is true, the children of the Urbject will not be included in the copy.
MeshUrbject.getInstance(u: MeshUrbject, camera: Camera): FrameInstance	Returns the FrameInstance of the Urbject with all of its Trigon Fragments added. See also: Urbject, FrameInstance, Trigon, Fragment

Home