spine-runtimes/spine-flutter/lib/generated/path_constraint_data.dart

//
// Spine Runtimes License Agreement
// Last updated April 5, 2025. Replaces all prior versions.
//
// Copyright (c) 2013-2025, Esoteric Software LLC
//
// Integration of the Spine Runtimes into software or otherwise creating
// derivative works of the Spine Runtimes is permitted under the terms and
// conditions of Section 2 of the Spine Editor License Agreement:
// http://esotericsoftware.com/spine-editor-license
//
// Otherwise, it is permitted to integrate the Spine Runtimes into software
// or otherwise create derivative works of the Spine Runtimes (collectively,
// "Products"), provided that each user of the Products must obtain their own
// Spine Editor license and redistribution of the Products in any form must
// include this license and copyright notice.
//
// THE SPINE RUNTIMES ARE PROVIDED BY ESOTERIC SOFTWARE LLC "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL ESOTERIC SOFTWARE LLC BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES,
// BUSINESS INTERRUPTION, OR LOSS OF USE, DATA, OR PROFITS) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THE SPINE RUNTIMES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//

// AUTO GENERATED FILE, DO NOT EDIT.

import 'package:universal_ffi/ffi.dart';
import 'package:universal_ffi/ffi_utils.dart';
import 'spine_dart_bindings_generated.dart';
import '../spine_bindings.dart';
import 'rtti.dart';
import 'arrays.dart';
import 'constraint.dart';
import 'constraint_data.dart';
import 'ik_constraint.dart';
import 'path_constraint.dart';
import 'path_constraint_pose.dart';
import 'physics_constraint.dart';
import 'posed_data.dart';
import 'position_mode.dart';
import 'rotate_mode.dart';
import 'skeleton.dart';
import 'slider.dart';
import 'slot_data.dart';
import 'spacing_mode.dart';
import 'transform_constraint.dart';

/// Stores the setup pose for a PathConstraint.
///
/// See https://esotericsoftware.com/spine-path-constraints Path constraints in
/// the Spine User Guide.
class PathConstraintData extends PosedData implements ConstraintData {
  final Pointer<spine_path_constraint_data_wrapper> _ptr;

  PathConstraintData.fromPointer(this._ptr)
      : super.fromPointer(SpineBindings.bindings.spine_path_constraint_data_cast_to_posed_data(_ptr));

  /// Get the native pointer for FFI calls
  @override
  Pointer get nativePtr => _ptr;

  factory PathConstraintData(String name) {
    final ptr = SpineBindings.bindings.spine_path_constraint_data_create(name.toNativeUtf8().cast<Char>());
    return PathConstraintData.fromPointer(ptr);
  }

  @override
  void dispose() {
    SpineBindings.bindings.spine_path_constraint_data_dispose(_ptr);
  }

  @override
  Rtti get rtti {
    final result = SpineBindings.bindings.spine_path_constraint_data_get_rtti(_ptr);
    return Rtti.fromPointer(result);
  }

  @override
  Constraint createMethod(Skeleton skeleton) {
    final result = SpineBindings.bindings.spine_path_constraint_data_create_method(_ptr, skeleton.nativePtr.cast());
    final rtti = SpineBindings.bindings.spine_constraint_get_rtti(result);
    final className = SpineBindings.bindings.spine_rtti_get_class_name(rtti).cast<Utf8>().toDartString();
    switch (className) {
      case 'IkConstraint':
        final castedPtr = SpineBindings.bindings.spine_constraint_cast_to_ik_constraint(result);
        return IkConstraint.fromPointer(castedPtr);
      case 'PathConstraint':
        final castedPtr = SpineBindings.bindings.spine_constraint_cast_to_path_constraint(result);
        return PathConstraint.fromPointer(castedPtr);
      case 'PhysicsConstraint':
        final castedPtr = SpineBindings.bindings.spine_constraint_cast_to_physics_constraint(result);
        return PhysicsConstraint.fromPointer(castedPtr);
      case 'Slider':
        final castedPtr = SpineBindings.bindings.spine_constraint_cast_to_slider(result);
        return Slider.fromPointer(castedPtr);
      case 'TransformConstraint':
        final castedPtr = SpineBindings.bindings.spine_constraint_cast_to_transform_constraint(result);
        return TransformConstraint.fromPointer(castedPtr);
      default:
        throw UnsupportedError('Unknown concrete type: $className for abstract class Constraint');
    }
  }

  /// The bones that will be modified by this path constraint.
  ArrayBoneData get bones {
    final result = SpineBindings.bindings.spine_path_constraint_data_get_bones(_ptr);
    return ArrayBoneData.fromPointer(result);
  }

  /// The slot whose path attachment will be used to constrained the bones.
  SlotData get slot {
    final result = SpineBindings.bindings.spine_path_constraint_data_get_slot(_ptr);
    return SlotData.fromPointer(result);
  }

  set slot(SlotData value) {
    SpineBindings.bindings.spine_path_constraint_data_set_slot(_ptr, value.nativePtr.cast());
  }

  /// The mode for positioning the first bone on the path.
  PositionMode get positionMode {
    final result = SpineBindings.bindings.spine_path_constraint_data_get_position_mode(_ptr);
    return PositionMode.fromValue(result);
  }

  set positionMode(PositionMode value) {
    SpineBindings.bindings.spine_path_constraint_data_set_position_mode(_ptr, value.value);
  }

  /// The mode for positioning the bones after the first bone on the path.
  SpacingMode get spacingMode {
    final result = SpineBindings.bindings.spine_path_constraint_data_get_spacing_mode(_ptr);
    return SpacingMode.fromValue(result);
  }

  set spacingMode(SpacingMode value) {
    SpineBindings.bindings.spine_path_constraint_data_set_spacing_mode(_ptr, value.value);
  }

  /// The mode for adjusting the rotation of the bones.
  RotateMode get rotateMode {
    final result = SpineBindings.bindings.spine_path_constraint_data_get_rotate_mode(_ptr);
    return RotateMode.fromValue(result);
  }

  set rotateMode(RotateMode value) {
    SpineBindings.bindings.spine_path_constraint_data_set_rotate_mode(_ptr, value.value);
  }

  /// An offset added to the constrained bone rotation.
  double get offsetRotation {
    final result = SpineBindings.bindings.spine_path_constraint_data_get_offset_rotation(_ptr);
    return result;
  }

  set offsetRotation(double value) {
    SpineBindings.bindings.spine_path_constraint_data_set_offset_rotation(_ptr, value);
  }

  PathConstraintPose get setupPose {
    final result = SpineBindings.bindings.spine_path_constraint_data_get_setup_pose(_ptr);
    return PathConstraintPose.fromPointer(result);
  }

  static Rtti rttiStatic() {
    final result = SpineBindings.bindings.spine_path_constraint_data_rtti();
    return Rtti.fromPointer(result);
  }
}