Vixen
02b45cc4
csharp
public readonly record struct Frame

A place a goal is expressed in: where it is, which way it faces, and how big it is.

No guide page documents this yet — the page shows what the code says about itself.

Remarks

Model space, for TwoBoneIk's reason. A pose has no opinion about where the character is standing, so every frame is brought into the pose's own space once, at resolve time, rather than the solver converting per joint. A frame that starts life in world space costs one transform here and nothing afterwards.

Fields and properties (5)

  • public BoneTransform Transform

    The place, in the character's model space.

  • public static Frame Identity

    The frame at the model-space origin.

  • public Vector3 Origin

    Where it is.

  • public Quaternion Rotation

    Which way it faces.

  • public Vector3 Scale

    How big it is. What makes a region scale with the body it is resolved against.

Methods (5)

  • public Frame(BoneTransform Transform)

    A place a goal is expressed in: where it is, which way it faces, and how big it is.

  • public Vector3 ToModel(Vector3 local)

    A point in the frame, in model space.

  • public Vector3 DirectionToModel(Vector3 local)

    A direction in the frame, in model space.

  • public Vector3 ToFrame(Vector3 model)

    A model-space point, in the frame's own space.

  • public static Frame Lerp(in Frame from, in Frame to, float amount)

    Part of the way from one frame to another.

Used by (24)

  • AimGoalVixen.Animation
  • AttachmentFrameVixen.Animation
  • AttachmentSocketVixen.Animation
  • CameraConstraintsVixen.Animation
  • ConstraintGizmosVixen.Animation
  • ConstraintStackVixen.Animation
  • DefaultConstraintArbiterVixen.Animation
  • EntityFrameVixen.Animation
  • IConstraintFrameVixen.Animation
  • InstanceVixen.Animation
  • JointFrameVixen.Animation
  • ModelTestFrameVixen.Animation.Tests
  • PositionGoalVixen.Animation
  • ProvidedFrameVixen.Animation
  • ProxyShapeTestsVixen.Animation.Tests
  • ResolvedGoalVixen.Animation
  • RigidBodySolverVixen.Animation
  • ScreenFrameVixen.Animation
  • SocketFrameVixen.Animation
  • SurfaceFrameVixen.Animation
  • TrajectoryFrameVixen.Animation
  • TrajectoryTestsVixen.Animation.Tests
  • WeightedTestArbiterVixen.Animation.Tests
  • WorldFrameVixen.Animation