Table of Contents

Interface IBlendShapeProvider

Provides access to weighted blend channels.

public interface IBlendShapeProvider : ICapability
Extension Methods

Remarks

This interface does not imply any semantic meaning of the channels. Channel names and behavior are implementation-defined.

Properties

ChannelNames

Case-sensitive keys for all available blend weights.

IReadOnlyCollection<string> ChannelNames { get; }

Property Value

IReadOnlyCollection<string>

HasWeights

Does this avatar have any blendshape weights?

bool HasWeights { get; }

Property Value

bool

Methods

GetWeight(string)

Gets the weight for the given name.

float GetWeight(string name)

Parameters

name string

Returns

float

Remarks

If multiple blend shape sources in the avatar have the same channel name, this gets the maximum weight.

HasWeight(string)

Checks if a weight channel with the given name exists.

bool HasWeight(string name)

Parameters

name string

Returns

bool

SetWeight(string, float)

Sets the weight for the given name.

void SetWeight(string name, float weight)

Parameters

name string
weight float

Remarks

If multiple blend shape sources in the avatar have the same channel name, this sets the weight for all of them.