Struct DOTSDynamicBone

This is a DOTSDynamicBone. This struct holds data used for calculations

Implements

IComponentData

Namespace: DOTSDynamicBone

Assembly: cs.temp.dll.dll

Syntax

[Serializable]
public struct DOTSDynamicBone : IComponentData

Remarks

This is a DOTSDynamicBone. This struct holds data used for calculations

Fields

Disabled

Set this to true to disable calculations on the bone

Declaration

public bool Disabled

Field Value

Type	Description
System.Boolean	set to true to disable all particle calculations within the bone set

m_BoneTotalLength

Declaration

public float m_BoneTotalLength

Field Value

Type	Description
System.Single	total length of the bone

m_Core

Declaration

public ParticleTransform m_Core

Field Value

Type	Description
ParticleTransform	This is a ParticleTransform that stores the data related to the m_RigComponentEntity Transform

m_Damping

Declaration

public float m_Damping

Field Value

Type	Description
System.Single	How much the bones slowed down.

m_DistanceToObject

Declaration

public float m_DistanceToObject

Field Value

Type	Description
System.Single	how far the Referenced Entity has to be in order for m_DistantDisable to be true

m_DistantDisable

Declaration

public bool m_DistantDisable

Field Value

Type	Description
System.Boolean	Disable physics simulation automatically if the entity is far from a specified Entity.

m_DistantDisabled

Declaration

public bool m_DistantDisabled

Field Value

Type	Description
System.Boolean	if true then physics calculations have been disabled on this bone.

m_Elasticity

Declaration

public float m_Elasticity

Field Value

Type	Description
System.Single	How much the force applied to return each bone to original orientation.

m_EndLength

Declaration

public float m_EndLength

Field Value

Type	Description
System.Single	If End Length is not zero, an extra bone is generated at the end of transform hierarchy.

m_EndOffset

Declaration

public float3 m_EndOffset

Field Value

Type	Description
float3	If End Offset is not zero, an extra bone is generated at the end of transform hierarchy.

m_Force

Declaration

public float3 m_Force

Field Value

Type	Description
float3	The force apply to bones.

m_FreezeAxis

Declaration

public DOTSDynamicBone.FreezeAxis m_FreezeAxis

Field Value

Type	Description
DOTSDynamicBone.FreezeAxis	Constrain bones to move on specified plane.

m_Friction

Declaration

public float m_Friction

Field Value

Type	Description
System.Single	How much the bones slowed down when collide.

m_Gravity

Declaration

public float3 m_Gravity

Field Value

Type	Description
float3	The force apply to bones. Partial force apply to character's initial pose is cancelled out.

m_Inert

Declaration

public float m_Inert

Field Value

Type	Description
System.Single	How much character's position change is ignored in physics simulation.

m_LocalGravity

Declaration

public float3 m_LocalGravity

Field Value

Type	Description
float3	local gravity of the bone

m_MaxRestLength

Declaration

public float m_MaxRestLength

Field Value

Type	Description
System.Single	NOT IMPLMENTED, TODO: determine if I want to implement this...

m_ParentAnimatedLocalToRootIndex

Declaration

public int m_ParentAnimatedLocalToRootIndex

Field Value

Type	Description
System.Int32	This is the Root DynamicBone Particle's parent index in the AnimatedLocalToRoot DynamicBuffer

m_Radius

Declaration

public float m_Radius

Field Value

Type	Description
System.Single	Each bone can be a sphere to collide with colliders. Radius describe sphere's size.

m_ReferenceObject

Declaration

public ParticleTransform m_ReferenceObject

Field Value

Type	Description
ParticleTransform	A PArticleTransform that represents the ReferendEntity's Transform

m_ReferenceObjectEntity

Declaration

public Entity m_ReferenceObjectEntity

Field Value

Type	Description
Entity	The Entity to use in the DistantDisable determination

m_RigComponentEntity

Declaration

public Entity m_RigComponentEntity

Field Value

Type	Description
Entity	This is the entity Entity that contained the RigComponent. Most likely this will be the same as the m_RootEntity

m_RootAnimatedLocalToRootIndex

Declaration

public int m_RootAnimatedLocalToRootIndex

Field Value

Type	Description
System.Int32	This is the index that the Root Entity's AnimatedLocalToRootIndex index. This will always most likly be 0 since it is the root

m_RootEntity

Declaration

public Entity m_RootEntity

Field Value

Type	Description
Entity	This is the Entity if the root transform (not to be confused with the RootBone Entity)

m_RootParentEntity

Declaration

public Entity m_RootParentEntity

Field Value

Type	Description
Entity	The root DynamicBone has a parent, and this Entity is that parent.

m_Stiffness

Declaration

public float m_Stiffness

Field Value

Type	Description
System.Single	How much bone's original orientation are preserved.

m_UpdateDataFrom

Declaration

public DOTSDynamicBoneClass.UpdateDataFrom m_UpdateDataFrom

Field Value

Type	Description
DOTSDynamicBoneClass.UpdateDataFrom	An option to choose where the data updates from. This was implemented

m_UpdateMode

Declaration

public DOTSDynamicBone.UpdateMode m_UpdateMode

Field Value

Type	Description
DOTSDynamicBone.UpdateMode	Internal physics simulation mode.

m_UpdateRate

Declaration

public float m_UpdateRate

Field Value

Type	Description
System.Single	Internal physics simulation rate.

m_Weight

Declaration

public float m_Weight

Field Value

Type	Description
System.Single	weight of bone.

UpdateLocalToWorldTransforms

Declaration

public bool UpdateLocalToWorldTransforms

Field Value

Type	Description
System.Boolean	this lets you know if the bone has given the DOTSDynamicBoneParticleLocalToWorldOverride_Tag tag. It currently has no other use but will be given one later

UpdateRotationTransforms

Declaration

public bool UpdateRotationTransforms

Field Value

Type	Description
System.Boolean	this lets you know if the bone has given the DOTSDynamicBoneParticleLocalToWorldOverride_Tag tag. It currently has no other use but will be given one later

UpdateTranslationTransforms

Declaration

public bool UpdateTranslationTransforms

Field Value

Type	Description
System.Boolean	this lets you know if the bone has given the DOTSDynamicBoneParticleLocalToWorldOverride_Tag tag. It currently has no other use but will be given one later

UseAnimatedLocalToRoot

Declaration

public bool UseAnimatedLocalToRoot

Field Value

Type	Description
System.Boolean	set this to true to have all calculated values be converted into AnimatedLocalToRootValues (required for it to not look weird, but disable it if you want, it's your game)

UseNaturalColliders

Declaration

public bool UseNaturalColliders

Field Value

Type	Description
System.Boolean

Methods

Create(GameObjectConversionSystem, RigComponent, Transform, DOTSDynamicBoneClass, Single)

V0.8.3+ Creates a DOTSDynamicBone using the given information

Declaration

public static DOTSDynamicBone Create(GameObjectConversionSystem m_ConversionSystem, RigComponent RigComponent, Transform Root, DOTSDynamicBoneClass boneComponent, float maxRestLength = 0.2F)

Parameters

Type	Name	Description
GameObjectConversionSystem	m_ConversionSystem	GameObjectConversionSystem
RigComponent	RigComponent	RigComponent
Transform	Root	Root Transform
DOTSDynamicBoneClass	boneComponent	DOTSDynamicBoneClass
System.Single	maxRestLength	NOT IMPLEMENTED

Returns

Type	Description
DOTSDynamicBone	DOTSDynamicBone

Disable(ref Particle[], Int32, Int32)

Disables the bone and all the given Particles. (NOTE: the particles should be associated with the bones)

Declaration

public void Disable(ref Particle[] m_Particles, int start, int end)

Parameters

Type	Name	Description
Particle[]	m_Particles	particles to be disabled
System.Int32	start
System.Int32	end

Disable(ref DynamicBuffer<Particle>, Int32, Int32)

Disables the bone and all the given Particles. (NOTE: the particles should be associated with the bones)

Declaration

public void Disable(ref DynamicBuffer<Particle> m_Particles, int start, int end)

Parameters

Type	Name	Description
DynamicBuffer<Particle>	m_Particles	particles to be disabled
System.Int32	start
System.Int32	end

Disable(ref List<Particle>, Int32, Int32)

Disables the bone and all the given Particles. (NOTE: the particles should be associated with the bones)

Declaration

public void Disable(ref List<Particle> m_Particles, int start, int end)

Parameters

Type	Name	Description
List<Particle>	m_Particles	particles to be disabled
System.Int32	start
System.Int32	end

Enable(ref Particle[], Int32, Int32)

Enables the bone and all the given Particles. (NOTE: the particles should be associated with the bones)

Declaration

public void Enable(ref Particle[] m_Particles, int start, int end)

Parameters

Type	Name	Description
Particle[]	m_Particles	particles to be enabled
System.Int32	start
System.Int32	end

Enable(ref DynamicBuffer<Particle>, Int32, Int32)

Enables the bone and all the given Particles. (NOTE: the particles should be associated with the bones)

Declaration

public void Enable(ref DynamicBuffer<Particle> m_Particles, int start, int end)

Parameters

Type	Name	Description
DynamicBuffer<Particle>	m_Particles	particles to be enabled
System.Int32	start
System.Int32	end

Enable(ref List<Particle>, Int32, Int32)

Enables the bone and all the given Particles. (NOTE: the particles should be associated with the bones)

Declaration

public void Enable(ref List<Particle> m_Particles, int start, int end)

Parameters

Type	Name	Description
List<Particle>	m_Particles	particles to be enabled
System.Int32	start
System.Int32	end

Implements

IComponentData