Package geomss.geom

Class PointVehicle

    • Method Detail

      • newInstance

        public static PointVehicle newInstance()
        Returns a new, empty, preallocated or recycled PointVehicle instance (on the stack when executing in a StackContext), that can store a list of PointComponent objects.
        Returns:
        A new, empty PointVehicle.

      • newInstance

        public static PointVehicle newInstance​(java.lang.String name)
        Returns a new, empty, preallocated or recycled PointVehicle instance (on the stack when executing in a StackContext) with the specified name, that can store a list of PointComponent objects.
        Parameters:
        name - The name to be assigned to this list (may be null).
        Returns:
        A new, empty PointVehicle.

      • valueOf

        public static PointVehicle valueOf​(java.lang.String name,
                                   java.util.Collection<? extends PointComponent> elements)
        Return a PointVehicle made up of the PointComponent objects in the specified collection.
        Parameters:
        name - The name to be assigned to this list (may be null).
        elements - A collection of PointComponent elements. May not be null.
        Returns:
        A new PointVehicle containing the elements in the specified collection.

      • valueOf

        public static PointVehicle valueOf​(java.lang.String name,
                                   PointComponent... elements)
        Return a PointVehicle made up of the PointComponent objects in the specified array.
        Parameters:
        name - The name to be assigned to this list (may be null).
        elements - A array of PointComponent elements. May not be null.
        Returns:
        A new PointVehicle containing the elements in the specified array.

      • valueOf

        public static PointVehicle valueOf​(PointComponent... elements)
        Return a PointVehicle made up of the PointComponent objects in the specified list.
        Parameters:
        elements - A list of PointComponent elements. May not be null.
        Returns:
        A new PointVehicle containing the elements in the specified array.

      • getRange

        public PointVehicle getRange​(int first,
                             int last)
        Returns the range of elements in this list from the specified start and ending indexes.
        Specified by:
        getRange in interface GeometryList<PointVehicle,​PointComponent>
        Specified by:
        getRange in class AbstractGeomList<PointVehicle,​PointComponent>
        Parameters:
        first - index of the first element to return (0 returns the 1st element, -1 returns the last, etc).
        last - index of the last element to return (0 returns the 1st element, -1 returns the last, etc).
        Returns:
        the list of elements in the given range from this list.
        Throws:
        java.lang.IndexOutOfBoundsException - if the given index is out of range: index ≥ size()

      • toDimension

        public PointVehicle toDimension​(int newDim)
        Return the equivalent of this list converted to the specified number of physical dimensions. If the number of dimensions is greater than this element, then zeros are added to the additional dimensions. If the number of dimensions is less than this element, then the extra dimensions are simply dropped (truncated). If the new dimensions are the same as the dimension of this element, then this list is simply returned.
        Parameters:
        newDim - The dimension of the element to return.
        Returns:
        The equivalent of this list converted to the new dimensions.

      • to

        public PointVehicle to​(javax.measure.unit.Unit<javax.measure.quantity.Length> unit)
        Returns the equivalent to this list but with all the elements stated in the specified unit.
        Parameters:
        unit - the length unit of the list to be returned. May not be null.
        Returns:
        an equivalent to this list but stated in the specified unit.
        Throws:
        javax.measure.converter.ConversionException - if the the input unit is not a length unit.

      • copy

        public PointVehicle copy()
        Returns a copy of this PointVehicle instance allocated by the calling thread (possibly on the stack).
        Returns:
        an identical and independent copy of this object.

      • copyToReal

        public PointVehicle copyToReal()
        Return a copy of this object with any transformations or subranges removed (applied).
        Returns:
        A copy of this list with any sub-element transformations or subranges removed.

      • getNumberOfPanels

        public int getNumberOfPanels()
                      throws java.lang.IndexOutOfBoundsException
        Return the total number of quadrilateral panels in this vehicle.
        Returns:
        the total number of panels in this vehicle.
        Throws:
        java.lang.IndexOutOfBoundsException - if the strings in any array in this vehicle have different lengths.

      • getTransformed

        public PointVehicle getTransformed​(GTransform transform)
        Returns transformed version of this element. The returned object implements GeomTransform and contains transformed versions of the contents of this list as children.
        Parameters:
        transform - The transform to apply to this geometry element. May not be null.
        Returns:
        A transformed version of this geometry element.
        Throws:
        DimensionException - if this element is not 3D.

      • set

        public PointComponent set​(int index,
                          PointComponent element)
        Replaces the PointComponent at the specified position in this list with the specified element. Null elements are ignored. The input element must have the same physical dimensions as the other items in this list, or an exception is thrown.
        Specified by:
        set in interface java.util.List<PointComponent>
        Overrides:
        set in class AbstractPointGeomList<PointVehicle,​PointComponent>
        Parameters:
        index - The index of the element to replace (0 returns the 1st element, -1 returns the last, -2 returns the 2nd from last, etc).
        element - The element to be stored at the specified position. null elements are ignored.
        Returns:
        The element previously at the specified position in this list. May not be null.
        Throws:
        java.lang.IndexOutOfBoundsException - - if index > size()
        DimensionException - if the input element's dimensions are different from this list's dimensions.

      • add

        public void add​(int index,
                PointComponent value)
        Inserts the specified PointComponent at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices). Null values are ignored. The input value must have the same physical dimensions as the other items in this list, or an exception is thrown.

        Note: If this method is used concurrent access must be synchronized (the list is not thread-safe).

        Specified by:
        add in interface java.util.List<PointComponent>
        Overrides:
        add in class AbstractPointGeomList<PointVehicle,​PointComponent>
        Parameters:
        index - the index at which the specified element is to be inserted. (0 returns the 1st element, -1 returns the last, -2 returns the 2nd from last, etc).
        value - the element to be inserted. May not be null.
        Throws:
        java.lang.IndexOutOfBoundsException - if index > size()
        DimensionException - if the input value dimensions are different from this list's dimensions.

      • addAll

        public boolean addAll​(int index,
                      java.util.Collection<? extends PointComponent> c)
        Inserts all of the PointComponent objects in the specified collection into this list at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. Note that this will occur if the specified collection is this list, and it's nonempty. The input elements must have the same physical dimensions as the other items in this list, or an exception is thrown.
        Specified by:
        addAll in interface java.util.List<PointComponent>
        Overrides:
        addAll in class AbstractGeomList<PointVehicle,​PointComponent>
        Parameters:
        index - index at which to insert first element from the specified collection.
        c - Elements to be inserted into this collection. May not be null.
        Returns:
        true if this collection changed as a result of the call.
        Throws:
        DimensionException - if the input element's dimensions are different from this list's dimensions.

      • recycle

        public static void recycle​(PointVehicle instance)
        Recycles a case instance immediately (on the stack when executing in a StackContext).
        Parameters:
        instance - The instance to be recycled.