class MAGES::MeshDeformations::TearActionData¶

Overview¶

class TearActionData: public MAGES::BaseActionData
{
public:
    // classes

    class CutCompletionTracker;
    class CutGroup;
    class Factory;

    // fields

    UniqueReference target = new UniqueReference();
    List<CutGroup> whatToCut = new List<CutGroup>();
    bool enableResetControl = false;
    Vector3 resetControlPosition = Vector3.zero;
    Quaternion resetControlRotation = Quaternion.identity;
    Vector3 resetControlScale = Vector3.one;

    // properties

    override GameObject[] ActionGameObjects;
};

Inherited Members¶

public:
    // enums

    enum ActionType;
    enum ObjectParentType;

    // fields

    string actionName;
    List attachedScripts = new List();
    StepContainer steps = new StepContainer();
    EffectDataCollection effects = new EffectDataCollection();
    bool isReplicated = true;
    string actionDescription;

    // properties

    List<BaseActionData> NextActions;
    List<BaseActionData> PrevActions;
    List AttachedScripts;
    Action PathEnd;
    string ID;
    string ActionName;
    bool AdvancedMode;
    Vector2 NodePosition;
    ActionState State;
    StepContainer Steps;
    EffectDataCollection Effects;
    string ActionDescription;
    GameObject[] ActionGameObjects;
    bool IsStartAction;
    bool IsReplicated;
    ActionType Type;
    bool IsAudible;

    // methods

    override bool Equals(object other);
    override int GetHashCode();
    virtual List<BaseActionData> GetLinkedActions();
    virtual List<BaseActionData> GetIncomingActions();
    virtual void RemapActions(Dictionary<BaseActionData, BaseActionData> map);

Detailed Documentation¶

Fields¶

UniqueReference target = new UniqueReference()

The object whose tetrahedral volume constraints will be cut.

List<CutGroup> whatToCut = new List<CutGroup>()

The set of cuts that must all be made for this action to complete.

bool enableResetControl = false

When true, an in-action world-space Reset button is spawned that restores the target to the untorn baseline captured when the action started. Opt-in: existing behavior is unchanged when off.

Vector3 resetControlPosition = Vector3.zero

World-space position applied to the spawned reset control.

Quaternion resetControlRotation = Quaternion.identity

World-space rotation applied to the spawned reset control.

Vector3 resetControlScale = Vector3.one

World-space scale applied to the spawned reset control. Defaults to Vector3.one.