de.javagl.jgltf.impl.v2.AccessorSparseIndices Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgltf-impl-v2 Show documentation
The newest version!
/*
 * glTF JSON model
 * 
 * Do not modify this class. It is automatically generated
 * with JsonModelGen (https://github.com/javagl/JsonModelGen)
 * Copyright (c) 2016-2021 Marco Hutter - http://www.javagl.de
 */

package de.javagl.jgltf.impl.v2;



/**
 * An object pointing to a buffer view containing the indices of 
 * deviating accessor values. The number of indices is equal to 
 * `accessor.sparse.count`. Indices **MUST** strictly increase. 
 * 
 * Auto-generated for accessor.sparse.indices.schema.json 
 * 
 */
public class AccessorSparseIndices
    extends GlTFProperty
{

    /**
     * The index of the buffer view with sparse indices. The referenced 
     * buffer view **MUST NOT** have its `target` or `byteStride` properties 
     * defined. The buffer view and the optional `byteOffset` **MUST** be 
     * aligned to the `componentType` byte length. (required) 
     * 
     */
    private Integer bufferView;
    /**
     * The offset relative to the start of the buffer view in bytes. 
     * (optional)
 
     * Default: 0
 
     * Minimum: 0 (inclusive) 
     * 
     */
    private Integer byteOffset;
    /**
     * The indices data type. (required)
 
     * Valid values: [5121, 5123, 5125] 
     * 
     */
    private Integer componentType;

    /**
     * The index of the buffer view with sparse indices. The referenced 
     * buffer view **MUST NOT** have its `target` or `byteStride` properties 
     * defined. The buffer view and the optional `byteOffset` **MUST** be 
     * aligned to the `componentType` byte length. (required) 
     * 
     * @param bufferView The bufferView to set
     * @throws NullPointerException If the given value is null
     * 
     */
    public void setBufferView(Integer bufferView) {
        if (bufferView == null) {
            throw new NullPointerException((("Invalid value for bufferView: "+ bufferView)+", may not be null"));
        }
        this.bufferView = bufferView;
    }

    /**
     * The index of the buffer view with sparse indices. The referenced 
     * buffer view **MUST NOT** have its `target` or `byteStride` properties 
     * defined. The buffer view and the optional `byteOffset` **MUST** be 
     * aligned to the `componentType` byte length. (required) 
     * 
     * @return The bufferView
     * 
     */
    public Integer getBufferView() {
        return this.bufferView;
    }

    /**
     * The offset relative to the start of the buffer view in bytes. 
     * (optional)
 
     * Default: 0
 
     * Minimum: 0 (inclusive) 
     * 
     * @param byteOffset The byteOffset to set
     * @throws IllegalArgumentException If the given value does not meet
     * the given constraints
     * 
     */
    public void setByteOffset(Integer byteOffset) {
        if (byteOffset == null) {
            this.byteOffset = byteOffset;
            return ;
        }
        if (byteOffset< 0) {
            throw new IllegalArgumentException("byteOffset < 0");
        }
        this.byteOffset = byteOffset;
    }

    /**
     * The offset relative to the start of the buffer view in bytes. 
     * (optional)
 
     * Default: 0
 
     * Minimum: 0 (inclusive) 
     * 
     * @return The byteOffset
     * 
     */
    public Integer getByteOffset() {
        return this.byteOffset;
    }

    /**
     * Returns the default value of the byteOffset
 
     * @see #getByteOffset 
     * 
     * @return The default byteOffset
     * 
     */
    public Integer defaultByteOffset() {
        return  0;
    }

    /**
     * The indices data type. (required)
 
     * Valid values: [5121, 5123, 5125] 
     * 
     * @param componentType The componentType to set
     * @throws NullPointerException If the given value is null
     * @throws IllegalArgumentException If the given value does not meet
     * the given constraints
     * 
     */
    public void setComponentType(Integer componentType) {
        if (componentType == null) {
            throw new NullPointerException((("Invalid value for componentType: "+ componentType)+", may not be null"));
        }
        if (((componentType!= 5121)&&(componentType!= 5123))&&(componentType!= 5125)) {
            throw new IllegalArgumentException((("Invalid value for componentType: "+ componentType)+", valid: [5121, 5123, 5125]"));
        }
        this.componentType = componentType;
    }

    /**
     * The indices data type. (required)
 
     * Valid values: [5121, 5123, 5125] 
     * 
     * @return The componentType
     * 
     */
    public Integer getComponentType() {
        return this.componentType;
    }

}