Creature Control for Unity v0.1
Loading...
Searching...
No Matches
Creatures.Insects.Antenna Class Reference

Description

An insect antenna.

Inheritance diagram for Creatures.Insects.Antenna:
Creatures.Bone

Public Member Functions

override Quaternion GetStdOrientation ()
 Get the standardized orientation for a bone.
override void DetectFeatures ()
 Detect features on this bone.
virtual void RemoveFeatures ()
 Remove features from this bone.

Static Public Member Functions

static BoneType SetBone< BoneType > (Creature creature, Transform transform)
 Set a Bone component to the give transform.
static void UnsetBone< BoneType > (Transform transform)
 Remove a bone from the given transform.

Public Attributes

Side side
Creature creature
 The creature to which the bone belongs.

Static Public Attributes

static readonly string nameOfFuniculus = nameof(_funiculus)
static readonly string nameOfEnd = nameof(_end)

Protected Member Functions

virtual void Initialize (Creature creature)
 Initiliaze the bone.

Properties

Transform scape [get, set]
Transform funiculus [get, set]
Transform end [get, set]
 The end of the antenna.
float scapeLength [get]
float funiculusLength [get]
bool isLeft [get]
bool isRight [get]

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.

◆ DetectFeatures()

override void Creatures.Insects.Antenna.DetectFeatures ( )
virtual

Detect features on this bone.

This can be child bones or specific properties for this bone

Reimplemented from Creatures.Bone.

◆ SetBone< BoneType >()

BoneType Creatures.Bone.SetBone< BoneType > ( Creature creature,
Transform transform )
staticinherited

Set a Bone component to the give transform.

Template Parameters
BoneTypeThe type of bone
Parameters
creatureThe creature to which the bone belongs
transformThe transform to assign the bone to
Returns
The newly created bone
Type Constraints
BoneType :Bone 

◆ UnsetBone< BoneType >()

void Creatures.Bone.UnsetBone< BoneType > ( Transform transform)
staticinherited

Remove a bone from the given transform.

Template Parameters
BoneTypeThe bone type to remove
Parameters
transformThe Transform to remove it from
Type Constraints
BoneType :Bone 

◆ Initialize()

virtual void Creatures.Bone.Initialize ( Creature creature)
protectedvirtualinherited

Initiliaze the bone.

Parameters
creatureThe creature to which the bone belongs

◆ RemoveFeatures()

virtual void Creatures.Bone.RemoveFeatures ( )
virtualinherited

Remove features from this bone.

This can be child bones or specific properties for this bone

Reimplemented in Creatures.Insects.Head.


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