Class SVGLoader

Hierarchy

  • Loader
    • SVGLoader

Constructors

constructor

Properties

crossOrigin defaultDPI defaultUnit manager path requestHeader resourcePath withCredentials DEFAULT_MATERIAL_NAME

Methods

load loadAsync parse setCrossOrigin setPath setRequestHeader setResourcePath setWithCredentials createShapes getStrokeStyle pointsToStroke pointsToStrokeWithBuffers

Constructors

constructor

  • new SVGLoader(manager?): SVGLoader

  • Parameters

    • Optionalmanager: LoadingManager

    Returns SVGLoader

Properties

crossOrigin

crossOrigin: string

Default

'anonymous'

defaultDPI

defaultDPI: number

defaultUnit

defaultUnit: string

manager

manager: LoadingManager

path

path: string

Default

''

requestHeader

requestHeader: {
    [header: string]: string;
}

Default

{}

resourcePath

resourcePath: string

Default

''

withCredentials

withCredentials: boolean

Default

false

StaticDEFAULT_MATERIAL_NAME

DEFAULT_MATERIAL_NAME: string

Methods

load

  • load(url, onLoad, onProgress?, onError?): void

  • Parameters

    • url: string
    • onLoad: ((data: SVGResult) => void)
        • (data): void

        • Parameters

          • data: SVGResult

          Returns void

    • OptionalonProgress: ((event: ProgressEvent<EventTarget>) => void)
        • (event): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    • OptionalonError: ((event: ErrorEvent) => void)
        • (event): void

        • Parameters

          • event: ErrorEvent

          Returns void

    Returns void

loadAsync

  • loadAsync(url, onProgress?): Promise<SVGResult>

  • Parameters

    • url: string
    • OptionalonProgress: ((event: ProgressEvent<EventTarget>) => void)
        • (event): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<SVGResult>

parse

  • parse(text): SVGResult

  • Parameters

    • text: string

    Returns SVGResult

setCrossOrigin

  • setCrossOrigin(crossOrigin): this

  • Parameters

    • crossOrigin: string

    Returns this

setPath

  • setPath(path): this

  • Parameters

    • path: string

    Returns this

setRequestHeader

  • setRequestHeader(requestHeader): this

  • Parameters

    • requestHeader: {
          [header: string]: string;
      }
      • [header: string]: string

    Returns this

setResourcePath

  • setResourcePath(resourcePath): this

  • Parameters

    • resourcePath: string

    Returns this

setWithCredentials

  • setWithCredentials(value): this

  • Parameters

    • value: boolean

    Returns this

StaticcreateShapes

  • createShapes(shapePath): Shape[]

  • Parameters

    • shapePath: ShapePath

    Returns Shape[]

StaticgetStrokeStyle

  • getStrokeStyle(width?, color?, lineJoin?, lineCap?, miterLimit?): StrokeStyle

  • Parameters

    • Optionalwidth: number
    • Optionalcolor: string
    • OptionallineJoin: string
    • OptionallineCap: string
    • OptionalmiterLimit: number

    Returns StrokeStyle

StaticpointsToStroke

  • pointsToStroke(points, style, arcDivisions?, minDistance?): BufferGeometry<NormalBufferAttributes>

  • Parameters

    • points: Vector2[]
    • style: StrokeStyle
    • OptionalarcDivisions: number
    • OptionalminDistance: number

    Returns BufferGeometry<NormalBufferAttributes>

StaticpointsToStrokeWithBuffers

  • pointsToStrokeWithBuffers(points, style, arcDivisions?, minDistance?, vertices?, normals?, uvs?, vertexOffset?): number

  • Parameters

    • points: Vector2[]
    • style: StrokeStyle
    • OptionalarcDivisions: number
    • OptionalminDistance: number
    • Optionalvertices: number[]
    • Optionalnormals: number[]
    • Optionaluvs: number[]
    • OptionalvertexOffset: number

    Returns number

Settings

Member Visibility

On This Page

Constructors
Properties
Methods