com.github.stephengold.joltjni.TrackedVehicleControllerSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jolt-jni-Windows64 Show documentation
a JNI interface to Jolt Physics
There is a newer version: 0.9.3
/*
Copyright (c) 2024 Stephen Gold

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 */
package com.github.stephengold.joltjni;

/**
 * Settings used to construct a {@code TrackedVehicleController}.
 *
 * @author Stephen Gold [email protected]
 */
public class TrackedVehicleControllerSettings
        extends VehicleControllerSettings {
    // *************************************************************************
    // constructors

    /**
     * Instantiate default settings.
     */
    public TrackedVehicleControllerSettings() {
        long settingsVa = createDefault();
        setVirtualAddress(settingsVa, true);
    }

    /**
     * Instantiate settings with the specified native object assigned but not
     * owned.
     *
     * @param settingsVa the virtual address of the native object to assign (not
     * zero)
     */
    TrackedVehicleControllerSettings(long settingsVa) {
        super(settingsVa);
    }
    // *************************************************************************
    // new methods exposed

    /**
     * Count how many tracks the vehicle will have. The settings are unaffected.
     * (native attribute: mTracks)
     *
     * @return the count (≥0)
     */
    public int getNumTracks() {
        long vehicleSettingsVa = va();
        int result = getNumTracks(vehicleSettingsVa);

        return result;
    }

    /**
     * Access the settings for the specified track. (native field: mTracks)
     *
     * @param index the index of the track to access (≥0)
     * @return a new JVM object with the pre-existing native object assigned
     */
    public VehicleTrackSettings getTrack(int index) {
        long vehicleSettingsVa = va();
        long trackVa = getTrack(vehicleSettingsVa, index);
        VehicleTrackSettings result = new VehicleTrackSettings(this, trackVa);

        return result;
    }
    // *************************************************************************
    // native private methods

    native private static long createDefault();

    native private static int getNumTracks(long vehicleSettingsVa);

    native private static long getTrack(long vehicleSettingsVa, int index);
}