API Reference — dna
92 entries across 37 modules.
By Task
DNA stream I/O
Read and write DNA assets in binary or JSON format.
| API | Module | Summary |
|---|---|---|
| BinaryStreamReader | BinaryStreamReader | Reads DNA data from binary format |
| BinaryStreamWriter | BinaryStreamWriter | Writes DNA data to binary format |
| JSONStreamReader | JSONStreamReader | Reads DNA data from JSON format |
| JSONStreamWriter | JSONStreamWriter | Writes DNA data to JSON format |
| Reader | Reader | Main DNA reader interface |
| Writer | Writer | Main DNA writer interface |
| StreamReader | StreamReader | Abstract base for DNA stream readers |
| StreamWriter | StreamWriter | Abstract base for DNA stream writers |
Configuration & setup
Control load-time options and coordinate transforms.
| API | Module | Summary |
|---|---|---|
| Configuration | Configuration | Aggregate load-time options for DNA reader |
| CoordinateSystem | Configuration | Complete spatial coordinate frame type |
| CoordinateSystemTransformPolicy | Configuration | Decide whether to convert coordinates |
| DataLayer | Configuration | Selects which data layers to load |
| UnknownLayerPolicy | Configuration | Controls handling of unrecognised layers |
| RotationSequence | Configuration | Euler rotation order during conversion |
| RotationSign | Configuration | Per-axis rotation sign during conversion |
| RotationUnit | Configuration | Unit for rotations (radians or degrees) |
| RotationDirection | Configuration | Direction of rotation (clockwise or counter-clockwise) |
| TranslationUnit | Configuration | Unit for translations (meters or centimeters) |
| Direction | Configuration | Axis direction values for coordinate systems |
| FaceWindingOrder | Configuration | Target face winding order |
DNA layers
Low-level data layer readers and writers.
| API | Module | Summary |
|---|---|---|
| BehaviorReader | BehaviorReader | Reads joint and blend-shape behavior |
| BehaviorWriter | BehaviorWriter | Writes joint and blend-shape behavior |
| DefinitionReader | DefinitionReader | Reads character definition metadata |
| DefinitionWriter | DefinitionWriter | Writes character definition metadata |
| DescriptorReader | DescriptorReader | Reads character descriptor |
| DescriptorWriter | DescriptorWriter | Writes character descriptor |
| GeometryReader | GeometryReader | Reads mesh geometry data |
| GeometryWriter | GeometryWriter | Writes mesh geometry data |
| HeaderReader | HeaderReader | Reads file header metadata |
| HeaderWriter | HeaderWriter | Writes file header metadata |
Descriptor & metadata
Character and mesh description structures.
| API | Module | Summary |
|---|---|---|
| Archetype | Descriptor | Character archetype enumeration |
| Gender | Descriptor | Gender classification enumeration |
| Delta | Geometry | Shape deformation delta structure |
| Normal | Geometry | Normal vector structure |
| Position | Geometry | Vertex position structure |
| TextureCoordinate | Geometry | Texture UV coordinate structure |
| VertexLayout | Geometry | Vertex data layout descriptor |
Joint behaviors
Joint transformation and behavior evaluation.
| API | Module | Summary |
|---|---|---|
| JointBehaviorMetadata | JointBehaviorMetadata | Metadata about joint transformation representations |
| JointBehaviorMetadataReader | JointBehaviorMetadataReader | Reads joint behavior metadata |
| JointBehaviorMetadataWriter | JointBehaviorMetadataWriter | Writes joint behavior metadata |
| RotationRepresentation | JointBehaviorMetadata | How rotations are represented |
| TranslationRepresentation | JointBehaviorMetadata | How translations are represented |
| ScaleRepresentation | JointBehaviorMetadata | How scales are represented |
Advanced behaviors
RBF, ML-based, and twist-swing joint behaviors.
| API | Module | Summary |
|---|---|---|
| RBFBehavior | RBFBehavior | Radial basis function behavior configuration |
| RBFBehaviorReader | RBFBehaviorReader | Reads RBF behavior data |
| RBFBehaviorWriter | RBFBehaviorWriter | Writes RBF behavior data |
| MachineLearnedBehavior | MachineLearnedBehavior | Machine-learned behavior configuration |
| MachineLearnedBehaviorReader | MachineLearnedBehaviorReader | Reads ML behavior data |
| MachineLearnedBehaviorWriter | MachineLearnedBehaviorWriter | Writes ML behavior data |
| ActivationFunction | MachineLearnedBehavior | Neural network activation function type |
| MachineLearnedBehaviorExt | MachineLearnedBehaviorExt | Extended ML behavior configuration |
| MachineLearnedBehaviorExtReader | MachineLearnedBehaviorExtReader | Reads extended ML behavior |
| MachineLearnedBehaviorExtWriter | MachineLearnedBehaviorExtWriter | Writes extended ML behavior |
| MachineLearnedBehaviorOperationType | MachineLearnedBehaviorExt | Type of ML operation |
| MachineLearnedBehaviorParameterKey | MachineLearnedBehaviorExt | Key for ML behavior parameters |
| TwistAxis | Twist | Axis for twist joint rotation |
| TwistSwingBehaviorReader | TwistSwingBehaviorReader | Reads twist-swing behavior |
| TwistSwingBehaviorWriter | TwistSwingBehaviorWriter | Writes twist-swing behavior |
RBF configuration
Radial basis function solver parameters.
| API | Module | Summary |
|---|---|---|
| AutomaticRadius | RBFBehavior | Automatic radius calculation mode |
| RBFDistanceMethod | RBFBehavior | Distance metric for RBF solver |
| RBFFunctionType | RBFBehavior | RBF basis function type |
| RBFNormalizeMethod | RBFBehavior | Normalization method for RBF outputs |
| RBFSolverType | RBFBehavior | RBF solver algorithm type |
Types & utilities
Mathematical and utility types.
| API | Module | Summary |
|---|---|---|
| Vector3 | Vector3 | 3-component floating-point vector |
| VersionInfo | VersionInfo | DNA file format version information |
| DefaultInstanceCreator | BinaryStreamReader | Creates default reader instances |
| DefaultInstanceDestroyer | BinaryStreamReader | Destroys reader instances |