All Classes Namespaces Functions Variables Enumerations Properties Pages
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
BipedReferences Class Reference

Contains references to bones common to all biped characters. More...

Classes

struct  AutoDetectParams
 Params for automatic biped recognition. (Using a struct here because I might need to add more parameters in the future). More...
 

Public Member Functions

bool IsEmpty (bool includeRoot)
 Gets a value indicating whether this BipedReferences is empty. If includeRoot is false, returns true(is empty) even if root Transform has been assigned. More...
 

Static Public Member Functions

static bool AutoDetectReferences (ref BipedReferences references, Transform root, AutoDetectParams autoDetectParams)
 Automatically detects biped bones. Returns true if a valid biped has been referenced. More...
 
static void DetectReferencesByNaming (ref BipedReferences references, Transform root, AutoDetectParams autoDetectParams)
 Detects the references based on naming and hierarchy. More...
 
static void AssignHumanoidReferences (ref BipedReferences references, Animator animator, AutoDetectParams autoDetectParams)
 Fills in BipedReferences using Animator.GetBoneTransform(). More...
 
static bool CheckSetupError (BipedReferences references, bool log)
 Checks the setup for definite problems. More...
 
static bool CheckSetupWarning (BipedReferences references, bool log)
 Checks the setup for possible problems. More...
 

Public Attributes

Transform root
 The root transform is the parent of all the biped's bones and should be located at ground level. More...
 
Transform pelvis
 The pelvis (hip) bone. More...
 
Transform leftThigh
 The first bone of the left leg. More...
 
Transform leftCalf
 The second bone of the left leg. More...
 
Transform leftFoot
 The third bone of the left leg. More...
 
Transform rightThigh
 The first bone of the right leg. More...
 
Transform rightCalf
 The second bone of the right leg. More...
 
Transform rightFoot
 The third bone of the right leg. More...
 
Transform leftUpperArm
 The first bone of the left arm. More...
 
Transform leftForearm
 The second bone of the left arm. More...
 
Transform leftHand
 The third bone of the left arm. More...
 
Transform rightUpperArm
 The first bone of the right arm. More...
 
Transform rightForearm
 The second bone of the right arm. More...
 
Transform rightHand
 The third bone of the right arm. More...
 
Transform head
 The head. More...
 
Transform[] spine = new Transform[0]
 The spine hierarchy. Should not contain any bone deeper in the hierarchy than the arms (neck or head). More...
 
Transform[] eyes = new Transform[0]
 The eyes. More...
 

Properties

bool isValid [get]
 Check for null references. More...
 
bool isEmpty [get]
 Gets a value indicating whether this BipedReferences is empty. More...
 

Detailed Description

Contains references to bones common to all biped characters.