Creatures.Insects.Antenna Class Reference

Description

An insect antenna.

Inheritance diagram for Creatures.Insects.Antenna:

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

Public Attributes
Quaternion	toLowerBoneRotation = Quaternion.identity
	The rotation from the target to the lower bone.
Side	side
	The body side of this antenna.
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	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	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.

Properties
new AntennaTarget	target [get]
	The pose target for this antenna.
Transform	upper [get, set]
	The Transform of the first or upper part of the antenna.
float	upperLength [get]
	The length of the upper bone.
Quaternion	toUpperBoneRotation [get]
	The rotation from the target to the upper bone.
Transform	lower [get, set]
	The Transform of the second or lower part of the antenna.
float	lowerLength [get]
	The length of the lower bone.
Transform	end [get, set]
	The end of the antenna.
bool	isLeft [get]
	Is the antenna on the left side?
bool	isRight [get]
	Is the antenna of the right side?

Member Function Documentation

GetStdOrientation()

override Quaternion Creatures.Insects.Antenna.GetStdOrientation ( )

virtual

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 from Creatures.Bone.

UpdatePose()

override void Creatures.Insects.Antenna.UpdatePose ( )

virtual

Update the pose of the bone based on the target.

Reimplemented from Creatures.Bone.

Member Data Documentation

nameOfUpper

readonly string Creatures.Insects.Antenna.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.Insects.Antenna.nameOfLower = nameof(_lower)

static

The name of the (private) _lower property.

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

nameOfEnd

readonly string Creatures.Insects.Antenna.nameOfEnd = nameof(_end)

static

The name of the (private) _end property.

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

---

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

• Antenna.cs