Options
Menu

Class PrimitivePolygonPrefab

A UV RegularPolygon primitive sprite.

Hierarchy

Implements

  • IAsset
  • IAssetAdapter

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new PrimitivePolygonPrefab(material?: MaterialBase, elementsType?: string, radius?: number, sides?: number, yUp?: boolean): PrimitivePolygonPrefab

  • Creates a new RegularPolygon disc object.

    Parameters

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

      The radius of the regular polygon

    • Default value sides: number = 16

      Defines the number of sides of the regular polygon.

    • Default value yUp: boolean = true

      Defines whether the regular polygon should lay on the Y-axis (true) or on the Z-axis (false).

    Returns PrimitivePolygonPrefab

Properties

_adapter

_adapter: IAssetAdapter

_pBottomRadius

_pBottomRadius: number

_pObjects

_pObjects: Array<DisplayObject>

_pSegmentsH

_pSegmentsH: number

_pSegmentsW

_pSegmentsW: number

_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

bottomClosed

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

  • Defines whether the bottom end of the cylinder is closed (true) or open.

    Returns boolean

  • Defines whether the bottom end of the cylinder is closed (true) or open.

    Parameters

    • value: boolean

    Returns void

bottomRadius

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

elementsType

  • get (): string

height

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

  • The radius of the top end of the cylinder.

    Returns number

  • The radius of the top end of the cylinder.

    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

radius

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

  • The radius of the regular polygon.

    Returns number

  • The radius of the regular polygon.

    Parameters

    • value: number

    Returns void

scaleU

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

scaleV

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

segmentsH

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

  • Defines the number of vertical segments that make up the cylinder. Defaults to 1.

    Returns number

  • Defines the number of vertical segments that make up the cylinder. Defaults to 1.

    Parameters

    • value: number

    Returns void

segmentsW

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

  • Defines the number of horizontal segments that make up the cylinder. Defaults to 16.

    Returns number

  • Defines the number of horizontal segments that make up the cylinder. Defaults to 16.

    Parameters

    • value: number

    Returns void

sides

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

  • The number of sides of the regular polygon.

    Returns number

  • The number of sides of the regular polygon.

    Parameters

    • value: number

    Returns void

subdivisions

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

  • The number of subdivisions from the edge to the center of the regular polygon.

    Returns number

  • The number of subdivisions from the edge to the center of the regular polygon.

    Parameters

    • value: number

    Returns void

topClosed

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

  • Defines whether the top end of the cylinder is closed (true) or open.

    Returns boolean

  • Defines whether the top end of the cylinder is closed (true) or open.

    Parameters

    • value: boolean

    Returns void

topRadius

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

  • The radius of the top end of the cylinder.

    Returns number

  • The radius of the top end of the cylinder.

    Parameters

    • value: number

    Returns void

yUp

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

  • Defines whether the cylinder poles should lay on the Y-axis (true) or on the Z-axis (false).

    Returns boolean

  • Defines whether the cylinder poles should lay on the Y-axis (true) or on the Z-axis (false).

    Parameters

    • value: boolean

    Returns void

Methods

_iValidate

  • _iValidate(): void

_pBuildGraphics

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

_pBuildUVs

  • _pBuildUVs(target: ElementsBase, elementsType: string): 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

setSegmentsH

  • setSegmentsH(value: number): void

setSegmentsW

  • setSegmentsW(value: number): void

updateFullPath

  • updateFullPath(): void

  • Returns void

Generated using TypeDoc