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

Description

A bone in the model's rig.

Inheritance diagram for Creatures.Bone:
Creatures.Head Creatures.Insects.Antenna Creatures.Leg Creatures.Tail Creatures.Insects.Head

Classes

class  Pair
 A (symmetric bone pair is present in the left and right side of the bone. More...

Public Member Functions

virtual Quaternion GetStdOrientation ()
 Get the standardized orientation for a bone.
virtual 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

Creature creature
 The creature to which the bone belongs.

Protected Member Functions

virtual void Initialize (Creature creature)
 Initiliaze the bone.

Member Function Documentation

◆ SetBone< BoneType >()

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

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)
static

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)
protectedvirtual

Initiliaze the bone.

Parameters
creatureThe creature to which the bone belongs

◆ GetStdOrientation()

virtual Quaternion Creatures.Bone.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 in Creatures.Head, Creatures.Insects.Antenna, and Creatures.Tail.

◆ DetectFeatures()

virtual void Creatures.Bone.DetectFeatures ( )
virtual

Detect features on this bone.

This can be child bones or specific properties for this bone

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

◆ RemoveFeatures()

virtual void Creatures.Bone.RemoveFeatures ( )
virtual

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: