Creatures.Leg Class Reference

Description

A leg of a creature.

Unity Properties

Inheritance diagram for Creatures.Leg:

Public Member Functions
override void	UpdatePose ()
	Update the pose of the bone based on the target.
virtual Quaternion	GetStdOrientation ()
	Get the standardized orientation for a bone.

Public Attributes
Quaternion	toUpperBoneRotation = Quaternion.identity
	The rotation to get from the target to the models' upper bone.
Transform	lowerEnd
	The transform representing the end of the lower leg.
Quaternion	toLowerBoneRotation = Quaternion.identity
	The rotation to get from the target to the models' lower bone.
Transform	extremityEnd
	The transform marking the end of the extremity.
Quaternion	toExtremityBoneRotation = Quaternion.identity
	The rotation to get from the target to the models' extremity bone.
Side	side
	The Side of of body where this leg is located.
Leg	otherSide
	The leg on the other Side of the body.
Creature	creature
	The creature to which the bone belongs.
Quaternion	toBoneRotation
	The rotation to transform the target orientation into the orientation of the bone.

Static Public Attributes
static readonly string	nameOfGirdle = nameof(_girdle)
	The name of the (private) _girdle property.
static readonly string	nameOfUpper = nameof(_upper)
	The name of the (private) _upper property.
static readonly string	nameOfLower = nameof(_lower)
	The name of the (private) _lower property.
static readonly string	nameOfExtremity = nameof(_extremity)
	The name of the (private) _extremity property.
static readonly string	nameOfPhalanges = nameof(_phalanges)
	The name of the (private) _phalanges property.
static readonly string	nameOfEnd = nameof(_end)
	The name of the (private) _end property.

Protected Member Functions
void	UpdatePoseUpper ()
	Update the pose of the upper bone based on its target.
void	UpdatePoseLower ()
	Update the pose of the lower bone based on its target.
void	UpdatePoseExtremity ()
	Update the pose of the extremity bone based on its target.

Properties
new LegTarget	target [get]
	The pose target for this leg.
Transform	girdle [get, set]
	The hip or coxa bone.
Transform	upper [get, set]
	The upper leg or thigh bone.
float	upperLength [get]
	The length of the upper leg bone.
Transform	lower [get, set]
	The lower leg or shank bone.
float	lowerLength [get]
	The length of the tibia bone.
Transform	extremity [get, set]
	The foot bone.
float	extremityLength [get]
	The length of the extremity bone.
Transform	phalanges [get, set]
	The toes.
float	phalangesLength [get]
	The length of the phalanges.
Transform	end [get, set]
	The end of the leg.
float	length [get]
	The length of the leg from hip to foot.
float	footLength [get]
	The size of the foot.
bool	isLeft [get]
	Is this leg at the left Side?
bool	isRight [get]
	Is this leg at the right Side?

Member Function Documentation

UpdatePose()

override void Creatures.Leg.UpdatePose ( )

virtual

Update the pose of the bone based on the target.

Reimplemented from Creatures.Bone.

GetStdOrientation()

virtual Quaternion Creatures.Bone.GetStdOrientation ( )

virtualinherited

Get the standardized orientation for a bone.

Returns

This orientation is independent from the orientation of the bone in the model The orientation matches the oriention in the target rig

Reimplemented in Creatures.Head, Creatures.Insects.Antenna, Creatures.Insects.Head, and Creatures.Tail.

Member Data Documentation

nameOfGirdle

readonly string Creatures.Leg.nameOfGirdle = nameof(_girdle)

static

The name of the (private) _girdle property.

This is only needed for the Unity UI Use upper for all other purposes

nameOfUpper

readonly string Creatures.Leg.nameOfUpper = nameof(_upper)

static

The name of the (private) _upper property.

This is only needed for the Unity UI Use upper for all other purposes

nameOfLower

readonly string Creatures.Leg.nameOfLower = nameof(_lower)

static

The name of the (private) _lower property.

This is only needed for the Unity UI Use lower for all other purposes

nameOfExtremity

readonly string Creatures.Leg.nameOfExtremity = nameof(_extremity)

static

The name of the (private) _extremity property.

This is only needed for the Unity UI Use extremity for all other purposes

nameOfPhalanges

readonly string Creatures.Leg.nameOfPhalanges = nameof(_phalanges)

static

The name of the (private) _phalanges property.

This is only needed for the Unity UI Use phalanges for all other purposes

nameOfEnd

readonly string Creatures.Leg.nameOfEnd = nameof(_end)

static

The name of the (private) _end property.

This is only needed for the Unity UI Use end for all other purposes

Property Documentation

length

float Creatures.Leg.length

get

The length of the leg from hip to foot.

This consists of the femur and tibia

footLength

float Creatures.Leg.footLength

get

The size of the foot.

This consists of the extremity and phalanges

---

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

• Leg.cs