Class FlowMap

constructor

• new FlowMap(width: number, height: number, data: Uint8ClampedArray): FlowMap

  Create a new flow map.

  Parameters

  • width: number

    defines the width of the flow map

  • height: number

    defines the height of the flow map

  • data: Uint8ClampedArray

    defines the data of the flow map

  Returns FlowMap

Readonlydata

Readonlyheight

Readonlywidth

processFlowable

• processFlowable(
      flowable: IFlowable,
      strength?: number,
      flowMapSamplePosOrTransformationMatrix?: Matrix | IVector3Like,
  ): void

  Applies the flow map to a flowable object.

  Parameters

  • flowable: IFlowable

    defines the object to update

  • strength: number = 1

    defines the strength of the flow map influence

  • OptionalflowMapSamplePosOrTransformationMatrix: Matrix | IVector3Like

    defines the flow map sample position or transformation matrix

  Returns void

StaticExtractFromTextureAsync

• ExtractFromTextureAsync(texture: Texture): Promise<FlowMap>

  Load from a texture

  Parameters

  • texture: Texture

    defines the source texture

  Returns Promise<FlowMap>

  a promise fulfilled when image data is loaded

StaticFromUrlAsync

• FromUrlAsync(url: string): Promise<FlowMap>

  Creates a FlowMap from a url.

  Parameters

  • url: string

    The url of the image to load

  Returns Promise<FlowMap>

  a promise that resolves to a FlowMap object