BehaviorWriter

Write-only accessors for DNA attributes that define the rig's evaluation.

Windows
MacOS
Linux

Warnings

  • Implementors should inherit from Writer itself and not this class.

Inheritance Hierarchy

References

Module

RigLogicLib

Header

/Engine/Plugins/Animation/RigLogic/Source/RigLogicLib/Public/dna/layers/BehaviorWriter.h

Include

#include "dna/layers/BehaviorWriter.h"

Syntax

class BehaviorWriter : public virtual dna::DefinitionWriter

Remarks

Implementors should inherit from Writer itself and not this class.

Destructors

Name Description

Protected function Virtual

~BehaviorWriter()

Functions

Name Description

Public function

void

 

clearJointGroups()

Delete all joint groups.

Public function

void

 

deleteJointGroup

(
    std::uint16_t jointGroupIndex
)

Delete the specified joint group.

Public function

void

 

setAnimatedMapCutValues

(
    const float* cutValues,
    std::uint16_t count
)

Computational values(vertical intercept) used for calculating the output value.

Public function

void

 

setAnimatedMapFromValues

(
    const float* fromValues,
    std::uint16_t count
)

Filter values(lower-bounds) used to decide whether a particular entry should be evaluated or not.

Public function

void

 

setAnimatedMapInputIndices

(
    const std::uint16_t* inputIndi...,
    std::uint16_t count
)

Input indices used to index into the array of input values.

Public function

void

 

setAnimatedMapLODs

(
    const std::uint16_t* lods,
    std::uint16_t count
)

Row count per each level of detail for animated maps. @note Each element's position represents the level itself (e.g. [0,1,2,3,4,5] Value 0 is LOD with highest of details, value 5 is LOD with lowest details), while the value denotes the number of rows (within the conditional table), belonging to that level.

Public function

void

 

setAnimatedMapOutputIndices

(
    const std::uint16_t* outputInd...,
    std::uint16_t count
)

Output indices that specify the computed output value's position.

Public function

void

 

setAnimatedMapSlopeValues

(
    const float* slopeValues,
    std::uint16_t count
)

Computational values(slope/gradient) used for calculating the output value.

Public function

void

 

setAnimatedMapToValues

(
    const float* toValues,
    std::uint16_t count
)

Filter values(upper-bounds) used to decide whether a particular entry should be evaluated or not.

Public function

void

 

setBlendShapeChannelInputIndices

(
    const std::uint16_t* inputIndi...,
    std::uint16_t count
)

Input indices used to index into the input vector.

Public function

void

 

setBlendShapeChannelLODs

(
    const std::uint16_t* lods,
    std::uint16_t count
)

Input index count per each level of detail for blend shapes. @note Each element's position represents the level itself (e.g. [0,1,2,3,4,5] Value 0 is LOD with highest of details, value 5 is LOD with lowest details), while the value denotes the number of input indices belonging to that level.

Public function

void

 

setBlendShapeChannelOutputIndices

(
    const std::uint16_t* outputInd...,
    std::uint16_t count
)

Output indices specify the positions of blend shape output values.

Public function

void

 

setGUIToRawCutValues

(
    const float* cutValues,
    std::uint16_t count
)

Computational values(vertical intercept) used for calculating the output value during gui to raw control mapping.

Public function

void

 

setGUIToRawFromValues

(
    const float* fromValues,
    std::uint16_t count
)

Filter values(lower-bounds) used to decide whether a particular entry should be evaluated or not during gui to raw control mapping.

Public function

void

 

setGUIToRawInputIndices

(
    const std::uint16_t* inputIndi...,
    std::uint16_t count
)

Input indices used for mapping gui to raw controls.

Public function

void

 

setGUIToRawOutputIndices

(
    const std::uint16_t* outputInd...,
    std::uint16_t count
)

Output indices used for mapping gui to raw controls.

Public function

void

 

setGUIToRawSlopeValues

(
    const float* slopeValues,
    std::uint16_t count
)

Computational values(slope/gradient) used for calculating the output value during gui to raw control mapping.

Public function

void

 

setGUIToRawToValues

(
    const float* toValues,
    std::uint16_t count
)

Filter values(upper-bounds) used to decide whether a particular entry should be evaluated or not during gui to raw control mapping.

Public function

void

 

setJointColumnCount

(
    std::uint16_t columnCount
)

Number of columns in the entire, uncompressed joint matrix.

Public function

void

 

setJointGroupInputIndices

(
    std::uint16_t jointGroupIndex,
    const std::uint16_t* inputIndi...,
    std::uint16_t count
)

Column indices that the specified joint group contains. @note The column indices point into the entire, uncompressed joint matrix.

Public function

void

 

setJointGroupJointIndices

(
    std::uint16_t jointGroupIndex,
    const std::uint16_t* jointIndi...,
    std::uint16_t count
)

Joint indices that the specified joint group contains.

Public function

void

 

setJointGroupLODs

(
    std::uint16_t jointGroupIndex,
    const std::uint16_t* lods,
    std::uint16_t count
)

Number of rows per each level of detail for the specified joint group. @note Each element's position represents the level itself, while the value denotes the number of rows within the joint group belonging to that level. e.g.: [12, 9, 3] | | + LOD-2 contains first 3 rows | + LOD-1 contains first 9 rows.

Public function

void

 

setJointGroupOutputIndices

(
    std::uint16_t jointGroupIndex,
    const std::uint16_t* outputInd...,
    std::uint16_t count
)

Row indices that the specified joint group contains. @note The row indices point into the entire, uncompressed joint matrix.

Public function

void

 

setJointGroupValues

(
    std::uint16_t jointGroupIndex,
    const float* values,
    std::uint32_t count
)

Values that the specified joint group contains.

Public function

void

 

setJointRowCount

(
    std::uint16_t rowCount
)

Number of rows in the entire, uncompressed joint matrix.

Public function

void

 

setPSDColumnIndices

(
    const std::uint16_t* columnInd...,
    std::uint16_t count
)

Control(input) indices which will become the columns of the PSD matrix.

Public function

void

 

setPSDCount

(
    std::uint16_t count
)

The number of distinct PSD expressions.

Public function

void

 

setPSDRowIndices

(
    const std::uint16_t* rowIndice...,
    std::uint16_t count
)

PSD(input) indices which will become the rows of the PSD matrix.

Public function

void

 

setPSDValues

(
    const float* weights,
    std::uint16_t count
)

Weights associated with each PSD row and column pair.

See Also

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss