Options
Menu

Class Max3DSParser

Max3DSParser provides a parser for the 3ds data type.

Hierarchy

  • ParserBase

Index

Constructors

constructor

  • new Max3DSParser(useSmoothingGroups?: boolean): Max3DSParser
  • Creates a new Max3DSParser object.

    Parameters

    • Default value useSmoothingGroups: boolean = true

      Determines whether the parser looks for smoothing groups in the 3ds file or assumes uniform smoothing. Defaults to true.

    Returns Max3DSParser

Properties

_iFileName

_iFileName: string

_isParsing

_isParsing: boolean

_pContent

_pContent: IAsset

content

content: IAsset

data

data: any

dataFormat

dataFormat: string

The data format of the file data to be parsed. Options are URLLoaderDataFormat.BINARY, URLLoaderDataFormat.ARRAY_BUFFER, URLLoaderDataFormat.BLOB, URLLoaderDataFormat.VARIABLES or URLLoaderDataFormat.TEXT.

dependencies

dependencies: Array<ResourceDependency>

A list of dependencies that need to be loaded and resolved for the object being parsed.

materialMode

materialMode: number

parsingComplete

parsingComplete: boolean

parsingFailure

parsingFailure: boolean

parsingPaused

parsingPaused: boolean

Static MORE_TO_PARSE

MORE_TO_PARSE: boolean

Returned by proceedParsing to indicate more parsing is needed, allowing asynchronous parsing.

Static PARSING_DONE

PARSING_DONE: boolean

Returned by proceedParsing to indicate no more parsing is needed.

Methods

_iResolveDependency

  • _iResolveDependency(resourceDependency: ResourceDependency): void
  • inheritdoc

    Parameters

    • resourceDependency: ResourceDependency

    Returns void

_iResolveDependencyFailure

  • _iResolveDependencyFailure(resourceDependency: ResourceDependency): void
  • inheritdoc

    Parameters

    • resourceDependency: ResourceDependency

    Returns void

_iResolveDependencyName

  • _iResolveDependencyName(resourceDependency: ResourceDependency, asset: IAsset): string
  • Resolve a dependency name

    Parameters

    • resourceDependency: ResourceDependency

      The dependency to be resolved.

    • asset: IAsset

    Returns string

_iResumeParsing

  • _iResumeParsing(): void
  • Returns void

_pAddDependency

  • _pAddDependency(id: string, req: URLRequest, retrieveAsRawData?: boolean, data?: any, suppressErrorEvents?: boolean, sub_id?: number): ResourceDependency
  • Parameters

    • id: string
    • req: URLRequest
    • Optional retrieveAsRawData: boolean
    • Optional data: any
    • Optional suppressErrorEvents: boolean
    • Optional sub_id: number

    Returns ResourceDependency

_pDieWithError

  • _pDieWithError(message?: string): void
  • Parameters

    • Optional message: string

    Returns void

_pFinalizeAsset

  • _pFinalizeAsset(asset: IAsset, name?: string): void
  • Parameters

    • asset: IAsset
    • Optional name: string

    Returns void

_pFinishParsing

  • _pFinishParsing(): void
  • Finish parsing the data.

    Returns void

Private _pGetByteData

  • _pGetByteData(): ByteArray
  • Returns ByteArray

Private _pGetData

  • _pGetData(): any
  • Returns any

Private _pGetTextData

  • _pGetTextData(): string
  • Returns string

_pHasTime

  • _pHasTime(): boolean
  • Tests whether or not there is still time left for parsing within the maximum allowed time frame per session.

    Returns boolean

    True if there is still time left, false if the maximum allotted time was exceeded and parsing should be interrupted.

_pOnInterval

  • _pOnInterval(event?: TimerEvent): void
  • Called when the parsing pause interval has passed and parsing can proceed.

    Parameters

    • Optional event: TimerEvent

    Returns void

_pPauseAndRetrieveDependencies

  • _pPauseAndRetrieveDependencies(): void
  • Returns void

_pPauseParsing

  • _pPauseParsing(): void
  • Returns void

_pProceedParsing

  • _pProceedParsing(): boolean
  • inheritdoc

    Returns boolean

_pStartParsing

  • _pStartParsing(frameLimit: number): void
  • Parameters

    • frameLimit: number

    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

dispatchEvent

  • dispatchEvent(event: EventBase): void
  • Dispatch an event

    method

    dispatchEvent

    Parameters

    • event: EventBase

    Returns void

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

parseAsync

  • parseAsync(data: any, frameLimit?: number): void
  • Parse data (possibly containing bytearry, plain text or BitmapAsset) asynchronously, meaning that the parser will periodically stop parsing so that the AVM may proceed to the next frame.

    Parameters

    • data: any

      The untyped data object in which the loaded data resides.

    • Optional frameLimit: number

      number of milliseconds of parsing allowed per frame. The actual time spent on a frame can exceed this number since time-checks can only be performed between logical sections of the parsing procedure.

    Returns void

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

Static supportsData

  • supportsData(data: any): boolean
  • Tests whether a data block can be parsed by the parser.

    Parameters

    • data: any

      The data block to potentially be parsed.

    Returns boolean

    Whether or not the given data is supported.

Static supportsType

  • supportsType(extension: string): boolean
  • Indicates whether or not a given file extension is supported by the parser.

    Parameters

    • extension: string

      The file extension of a potential file to be parsed.

    Returns boolean

    Whether or not the given file type is supported.

Generated using TypeDoc