Astra.Asset.RigLoadJob Class Reference

Handles creating a RigItem as a job More...

Inheritance diagram for Astra.Asset.RigLoadJob:

Classes
class	RigLoadOptions
	Options for loading a rig More...
class	RigLoadResult
	Results from loading a rig 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 RigLoadResult	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< RigLoadJob.RigLoadResult, 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...

Protected Member Functions
BoneItem	BuildBoneItem (PrimitiveBone pb, GameObject templateGO)
Dictionary< string, string >	GetLegacyMecanimMapping (Dictionary< string, BoneItem > boneItems)

Detailed Description

Handles creating a RigItem as a job

Member Function Documentation

GetError()

override Loader.LoadError Astra.Asset.RigLoadJob.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< RigLoadJob.RigLoadResult, Loader.LoadError >.

GetLegacyMecanimMapping()

Dictionary< string, string > Astra.Asset.RigLoadJob.GetLegacyMecanimMapping ( Dictionary< string, BoneItem >  boneItems )

inlineprotected

This is the legacy backwards compatible rig to mecanim mapping loader If you get a warning during Rig.Load about this it means your PrimitiveRig does not have a unity_bone_id_to_mecanim_id mapping built into the PrimitiveRig

GetResult()

override RigLoadResult Astra.Asset.RigLoadJob.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< RigLoadJob.RigLoadResult, Loader.LoadError >.

---

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

• Assets/Astra/Asset/Rig/RigLoadJob.cs