Astra.Asset.MorphableLoadJob Class Reference

Used to load a MorphableItem, which can be tweaked to change an AvatarItem's shape More...

Inheritance diagram for Astra.Asset.MorphableLoadJob:

Classes
class	MorphableLoadOptions
	Options for loading a MorphableItem More...
class	MorphableLoadResult
	Results from loading a MorphableItem More...

Public Member Functions
override Loader.LoadError	GetError ()
	When the job is complete this function can be called by the developer to access the error data set which can be of any type (defined as T2). This needs to be defined if your derived class as an override. More...
override MorphableLoadResult	GetResult ()
	When the job is complete this function can be called by the developer to access the result data set which can be of any type (defined as T1). This needs to be defined if your derived class as an override. More...
Public Member Functions inherited from Astra.ApiJobWithResult< MorphableLoadJob.MorphableLoadResult, Loader.LoadError >
IEnumerator	AsCoroutine (Action< float > progress=null, Action< T1 > onComplete=null, Action< T2 > onFailed=null)
	Wraps a job to be used within a coroutine More...

Static Public Member Functions
static ProjectionJob	Project (string morphId, string sourceMeshId, string targetMeshId, string sourceMaskId=null, bool refresh=false, int parentJobId=Job.kNoParentJobId)
	Takes a source and target mesh and creates a new PrimitiveMorphable by projecting it in our c++ lib NOTE: the sourceMeshId will be projected onto the targetMeshId for convenience, TODO: get rid of this extra step More...

Protected Member Functions
bool?	Execute (Job job)

Detailed Description

Used to load a MorphableItem, which can be tweaked to change an AvatarItem's shape

Member Function Documentation

GetError()

override Loader.LoadError Astra.Asset.MorphableLoadJob.GetError ( )

inlinevirtual

When the job is complete this function can be called by the developer to access the error data set which can be of any type (defined as T2). This needs to be defined if your derived class as an override.

Returns

Yields the error result data

Implements Astra.ApiJobWithResult< MorphableLoadJob.MorphableLoadResult, Loader.LoadError >.

GetResult()

override MorphableLoadResult Astra.Asset.MorphableLoadJob.GetResult ( )

inlinevirtual

When the job is complete this function can be called by the developer to access the result data set which can be of any type (defined as T1). This needs to be defined if your derived class as an override.

Returns

Yields the success result data

Implements Astra.ApiJobWithResult< MorphableLoadJob.MorphableLoadResult, Loader.LoadError >.

Project()

static ProjectionJob Astra.Asset.MorphableLoadJob.Project ( string  morphId, string  sourceMeshId, string  targetMeshId, string  sourceMaskId = null, bool  refresh = false, int  parentJobId = Job.kNoParentJobId  )

inlinestatic

Takes a source and target mesh and creates a new PrimitiveMorphable by projecting it in our c++ lib NOTE: the sourceMeshId will be projected onto the targetMeshId for convenience, TODO: get rid of this extra step

Parameters

morphId	Guid of the morphable to project
sourceMeshId	Guid of the source mesh to project
targetMeshId	Guid of the target mesh to project onto
sourceMaskId	Guid of the mask to use. Optional
refresh	Whether this should force an immediate refresh after the operation. Optional, defaults to false.
parentJobId	Id of the parent job, if it applies. Optional.

---

The documentation for this class was generated from the following file:

• Assets/Astra/Asset/Morphable/MorphableLoadJob.cs