Options
Menu

Class PrimitiveCubePrefab

A Cube primitive prefab.

Hierarchy

Implements

  • IAsset
  • IAssetAdapter

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new PrimitiveCubePrefab(material?: MaterialBase, elementsType?: string, width?: number, height?: number, depth?: number, segmentsW?: number, segmentsH?: number, segmentsD?: number, tile6?: boolean): PrimitiveCubePrefab

  • Creates a new Cube object.

    Parameters

    • Default value material: MaterialBase = null
    • Default value elementsType: string = "triangle"
    • Default value width: number = 100

      The size of the cube along its X-axis.

    • Default value height: number = 100

      The size of the cube along its Y-axis.

    • Default value depth: number = 100

      The size of the cube along its Z-axis.

    • Default value segmentsW: number = 1

      The number of segments that make up the cube along the X-axis.

    • Default value segmentsH: number = 1

      The number of segments that make up the cube along the Y-axis.

    • Default value segmentsD: number = 1

      The number of segments that make up the cube along the Z-axis.

    • Default value tile6: boolean = true

      The type of uv mapping to use. When true, a texture will be subdivided in a 2x3 grid, each used for a single face. When false, the entire image is mapped on each face.

    Returns PrimitiveCubePrefab

Properties

_adapter

_adapter: IAssetAdapter

_pObjects

_pObjects: Array<DisplayObject>

_primitiveDirty

_primitiveDirty: boolean

_scaleU

_scaleU: number

_scaleV

_scaleV: number

_uvDirty

_uvDirty: boolean

adaptee

adaptee: AssetBase

adapter

adapter: IAssetAdapter

adapter is used to provide MovieClip to scripts taken from different platforms setter typically managed by factory. getter defaults to AwayJS class

assetFullPath

assetFullPath: Array<string>

assetNamespace

assetNamespace: string

id

id: number

A unique id for the asset, used to identify assets in an associative array

name

name: string

originalName

originalName: string

The original name used for this asset in the resource (e.g. file) in which it was found. This may not be the same as name, which may have changed due to of a name conflict.

Static DEFAULT_NAMESPACE

DEFAULT_NAMESPACE: string

Static ID_COUNT

ID_COUNT: number

Static assetType

assetType: string

Accessors

assetType

  • get (): string

depth

  • get (): number
  • set (value: number): void

  • The size of the cube along its Z-axis.

    Returns number

  • The size of the cube along its Z-axis.

    Parameters

    • value: number

    Returns void

elementsType

  • get (): string

height

  • get (): number
  • set (value: number): void

  • The size of the cube along its Y-axis.

    Returns number

  • The size of the cube along its Y-axis.

    Parameters

    • value: number

    Returns void

material

  • get (): MaterialBase
  • set (value: MaterialBase): void

  • The material with which to render the primitive.

    Returns MaterialBase

  • The material with which to render the primitive.

    Parameters

    • value: MaterialBase

    Returns void

scaleU

  • get (): number
  • set (value: number): void

scaleV

  • get (): number
  • set (value: number): void

segmentsD

  • get (): number
  • set (value: number): void

  • The number of segments that make up the cube along the Z-axis. Defaults to 1.

    Returns number

  • The number of segments that make up the cube along the Z-axis. Defaults to 1.

    Parameters

    • value: number

    Returns void

segmentsH

  • get (): number
  • set (value: number): void

  • The number of segments that make up the cube along the Y-axis. Defaults to 1.

    Returns number

  • The number of segments that make up the cube along the Y-axis. Defaults to 1.

    Parameters

    • value: number

    Returns void

segmentsW

  • get (): number
  • set (value: number): void

  • The number of segments that make up the cube along the X-axis. Defaults to 1.

    Returns number

  • The number of segments that make up the cube along the X-axis. Defaults to 1.

    Parameters

    • value: number

    Returns void

tile6

  • get (): boolean
  • set (value: boolean): void

  • The type of uv mapping to use. When false, the entire image is mapped on each face. When true, a texture will be subdivided in a 3x2 grid, each used for a single face. Reading the tiles from left to right, top to bottom they represent the faces of the cube in the following order: bottom, top, back, left, front, right. This creates several shared edges (between the top, front, left and right faces) which simplifies texture painting.

    Returns boolean

  • The type of uv mapping to use. When false, the entire image is mapped on each face. When true, a texture will be subdivided in a 3x2 grid, each used for a single face. Reading the tiles from left to right, top to bottom they represent the faces of the cube in the following order: bottom, top, back, left, front, right. This creates several shared edges (between the top, front, left and right faces) which simplifies texture painting.

    Parameters

    • value: boolean

    Returns void

width

  • get (): number
  • set (value: number): void

  • The size of the cube along its X-axis.

    Returns number

  • The size of the cube along its X-axis.

    Parameters

    • value: number

    Returns void

Methods

_iValidate

  • _iValidate(): void

_pBuildGraphics

  • _pBuildGraphics(target: ElementsBase, elementsType: string): void
  • inheritdoc

    Parameters

    • target: ElementsBase
    • elementsType: string

    Returns void

_pBuildUVs

  • _pBuildUVs(target: ElementsBase, elementsType: string): void
  • inheritdoc

    Parameters

    • target: ElementsBase
    • elementsType: string

    Returns void

_pCreateObject

_pInvalidatePrimitive

  • _pInvalidatePrimitive(): void

_pInvalidateUVs

  • _pInvalidateUVs(): void

  • Invalidates the primitive's uv coordinates, causing them to be updated when requested.

    Returns void

addEventListener

  • addEventListener(type: string, listener: function): void

  • Add an event listener

    method

    addEventListener

    Parameters

    • type: string
    • listener: function
        • (event: EventBase): void

        • Parameters

          • event: EventBase

          Returns void

    Returns void

assetPathEquals

  • assetPathEquals(name: string, ns: string): boolean

  • Parameters

    • name: string
    • ns: string

    Returns boolean

clear

  • clear(): void

  • Returns void

dispatchEvent

  • dispatchEvent(event: EventBase): void

  • Dispatch an event

    method

    dispatchEvent

    Parameters

    • event: EventBase

    Returns void

dispose

  • dispose(): void
  • inheritdoc

    Returns void

getNewObject

hasEventListener

  • hasEventListener(type: string, listener?: function): boolean

  • check if an object has an event listener assigned to it

    method

    hasListener

    Parameters

    • type: string
    • Optional listener: function
        • (event: EventBase): void

        • Parameters

          • event: EventBase

          Returns void

    Returns boolean

invalidate

  • invalidate(): void

  • Returns void

isAsset

  • isAsset(assetClass: IAssetClass): boolean

  • Parameters

    • assetClass: IAssetClass

    Returns boolean

removeEventListener

  • removeEventListener(type: string, listener: function): void

  • Remove an event listener

    method

    removeEventListener

    Parameters

    • type: string
    • listener: function
        • (event: EventBase): void

        • Parameters

          • event: EventBase

          Returns void

    Returns void

resetAssetPath

  • resetAssetPath(name: string, ns?: string, overrideOriginal?: boolean): void

  • Parameters

    • name: string
    • Optional ns: string
    • Optional overrideOriginal: boolean

    Returns void

updateFullPath

  • updateFullPath(): void

  • Returns void

Generated using TypeDoc