GeneralTransform3D (openjfx 8.0.202 API)

java.lang.Object
- com.sun.javafx.geom.transform.GeneralTransform3D

All Implemented Interfaces:

CanTransformVec3d
```
public final class GeneralTransform3D
extends Object
implements CanTransformVec3d
```
A general-purpose 4x4 transform that may or may not be affine. The GeneralTransform is typically used only for projection transforms.

Field Summary

Fields
Modifier and Type Field and Description

protected double[] mat

Fields
Modifier and Type	Field and Description
`protected double[]`	`mat`

Constructor Summary

Constructors
Constructor and Description

GeneralTransform3D()
Constructs and initializes a transform to the identity matrix.

Constructors
Constructor and Description
`GeneralTransform3D()` Constructs and initializes a transform to the identity matrix.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`computeClipZCoord()`
`GeneralTransform3D`	`copy()`
`double`	`determinant()` Computes the determinant of this transform.
`double[]`	`get(double[] rv)` Returns a copy of an array of 16 values that contains the 4x4 matrix of this transform.
`double`	`get(int index)`
`GeneralTransform3D`	`invert()` Inverts this transform in place.
`boolean`	`isAffine()` Returns true if the transform is affine.
`boolean`	`isIdentity()` Returns true if the transform is identity.
`GeneralTransform3D`	`mul(BaseTransform t1)` Sets the value of this transform to the result of multiplying itself with transform t1 : this = this * t1.
`GeneralTransform3D`	`mul(GeneralTransform3D t1)` Sets the value of this transform to the result of multiplying itself with transform t1 : this = this * t1.
`GeneralTransform3D`	`ortho(double left, double right, double bottom, double top, double near, double far)` Sets the value of this transform to an orthographic (parallel) projection transform.
`GeneralTransform3D`	`perspective(boolean verticalFOV, double fov, double aspect, double zNear, double zFar)` Sets the value of this transform to a perspective projection transform.
`GeneralTransform3D`	`scale(double sx, double sy, double sz)` Sets the value of this transform to the result of multiplying itself with a scale transform:
`GeneralTransform3D`	`set(double[] m)` Sets the matrix values of this transform to the values in the specified array.
`GeneralTransform3D`	`set(GeneralTransform3D t1)` Sets the value of this transform to the specified transform.
`GeneralTransform3D`	`setIdentity()` Sets this transform to the identity matrix.
`String`	`toString()` Returns the matrix elements of this transform as a string.
`BaseBounds`	`transform(BaseBounds src, BaseBounds dst)`
`Point2D`	`transform(Point2D point, Point2D pointOut)` Transform 2D point (with z == 0)
`Vec3d`	`transform(Vec3d point)` Transforms the point parameter with this transform and places the result back into point.
`Vec3d`	`transform(Vec3d point, Vec3d pointOut)` Transforms the point parameter with this transform and places the result into pointOut.
`Vec3f`	`transformNormal(Vec3f normal)` Transforms the normal parameter by this transform and places the value back into normal.
`Vec3f`	`transformNormal(Vec3f normal, Vec3f normalOut)` Transforms the normal parameter by this transform and places the value into normalOut.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - mat
```
protected double[] mat
```
- Constructor Detail
  - GeneralTransform3D
```
public GeneralTransform3D()
```
    Constructs and initializes a transform to the identity matrix.
- Method Detail
  - isAffine
```
public boolean isAffine()
```
    Returns true if the transform is affine. A transform is considered to be affine if the last row of its matrix is (0,0,0,1). Note that an instance of AffineTransform3D is always affine.
  - set
```
public GeneralTransform3D set(GeneralTransform3D t1)
```
    Sets the value of this transform to the specified transform.
    
    Parameters:
    
    t1 - the transform to copy into this transform.
    
    Returns:
    
    this transform
  - set
```
public GeneralTransform3D set(double[] m)
```
    Sets the matrix values of this transform to the values in the specified array.
    
    Parameters:
    
    m - an array of 16 values to copy into this transform in row major order.
    
    Returns:
    
    this transform
  - get
```
public double[] get(double[] rv)
```
    Returns a copy of an array of 16 values that contains the 4x4 matrix of this transform. The first four elements of the array will contain the top row of the transform matrix, etc.
    
    Parameters:
    
    rv - the return value, or null
    
    Returns:
    
    an array of 16 values
  - get
```
public double get(int index)
```
  - transform
```
public BaseBounds transform(BaseBounds src,
                            BaseBounds dst)
```
  - transform
```
public Point2D transform(Point2D point,
                         Point2D pointOut)
```
    Transform 2D point (with z == 0)
    
    Parameters:
    
    point -
    
    pointOut -
    
    Returns:
  - transform
```
public Vec3d transform(Vec3d point,
                       Vec3d pointOut)
```
    Transforms the point parameter with this transform and places the result into pointOut. The fourth element of the point input paramter is assumed to be one.
    
    Specified by:
    
    transform in interface CanTransformVec3d
    
    Parameters:
    
    point - the input point to be transformed
    
    pointOut - the transformed point
    
    Returns:
    
    the transformed point
  - transform
```
public Vec3d transform(Vec3d point)
```
    Transforms the point parameter with this transform and places the result back into point. The fourth element of the point input paramter is assumed to be one.
    
    Parameters:
    
    point - the input point to be transformed
    
    Returns:
    
    the transformed point
  - transformNormal
```
public Vec3f transformNormal(Vec3f normal,
                             Vec3f normalOut)
```
    Transforms the normal parameter by this transform and places the value into normalOut. The fourth element of the normal is assumed to be zero. Note: For correct lighting results, if a transform has uneven scaling surface normals should transformed by the inverse transpose of the transform. This the responsibility of the application and is not done automatically by this method.
    
    Parameters:
    
    normal - the input normal to be transformed
    
    normalOut - the transformed normal
    
    Returns:
    
    the transformed normal
  - transformNormal
```
public Vec3f transformNormal(Vec3f normal)
```
    Transforms the normal parameter by this transform and places the value back into normal. The fourth element of the normal is assumed to be zero. Note: For correct lighting results, if a transform has uneven scaling surface normals should transformed by the inverse transpose of the transform. This the responsibility of the application and is not done automatically by this method.
    
    Parameters:
    
    normal - the input normal to be transformed
    
    Returns:
    
    the transformed normal
  - perspective
```
public GeneralTransform3D perspective(boolean verticalFOV,
                                      double fov,
                                      double aspect,
                                      double zNear,
                                      double zFar)
```
    Sets the value of this transform to a perspective projection transform. This transform maps points from Eye Coordinates (EC) to Clipping Coordinates (CC). Note that the field of view is specified in radians.
    
    Parameters:
    
    verticalFOV - specifies whether the fov is vertical (Y direction).
    
    fov - specifies the field of view in radians
    
    aspect - specifies the aspect ratio. The aspect ratio is the ratio of width to height.
    
    zNear - the distance to the frustum's near clipping plane. This value must be positive, (the value -zNear is the location of the near clip plane).
    
    zFar - the distance to the frustum's far clipping plane
    
    Returns:
    
    this transform
  - ortho
```
public GeneralTransform3D ortho(double left,
                                double right,
                                double bottom,
                                double top,
                                double near,
                                double far)
```
    Sets the value of this transform to an orthographic (parallel) projection transform. This transform maps coordinates from Eye Coordinates (EC) to Clipping Coordinates (CC). Note that unlike the similar function in OpenGL, the clipping coordinates generated by the resulting transform are in a right-handed coordinate system.
    
    Parameters:
    
    left - the vertical line on the left edge of the near clipping plane mapped to the left edge of the graphics window
    
    right - the vertical line on the right edge of the near clipping plane mapped to the right edge of the graphics window
    
    bottom - the horizontal line on the bottom edge of the near clipping plane mapped to the bottom edge of the graphics window
    
    top - the horizontal line on the top edge of the near clipping plane mapped to the top edge of the graphics window
    
    near - the distance to the frustum's near clipping plane (the value -near is the location of the near clip plane)
    
    far - the distance to the frustum's far clipping plane
    
    Returns:
    
    this transform
  - computeClipZCoord
```
public double computeClipZCoord()
```
  - determinant
```
public double determinant()
```
    Computes the determinant of this transform.
    
    Returns:
    
    the determinant
  - invert
```
public GeneralTransform3D invert()
```
    Inverts this transform in place.
    
    Returns:
    
    this transform
  - mul
```
public GeneralTransform3D mul(BaseTransform t1)
```
    Sets the value of this transform to the result of multiplying itself with transform t1 : this = this * t1.
    
    Parameters:
    
    t1 - the other transform
    
    Returns:
    
    this transform
  - scale
```
public GeneralTransform3D scale(double sx,
                                double sy,
                                double sz)
```
    Sets the value of this transform to the result of multiplying itself with a scale transform:
```
 scaletx =
     [ sx  0  0  0 ]
     [  0 sy  0  0 ]
     [  0  0 sz  0 ]
     [  0  0  0  1 ].
 this = this * scaletx.
 
```
    Parameters:
    
    sx - the X coordinate scale factor
    
    sy - the Y coordinate scale factor
    
    sz - the Z coordinate scale factor
    
    Returns:
    
    this transform
  - mul
```
public GeneralTransform3D mul(GeneralTransform3D t1)
```
    Sets the value of this transform to the result of multiplying itself with transform t1 : this = this * t1.
    
    Parameters:
    
    t1 - the other transform
    
    Returns:
    
    this transform
  - setIdentity
```
public GeneralTransform3D setIdentity()
```
    Sets this transform to the identity matrix.
    
    Returns:
    
    this transform
  - isIdentity
```
public boolean isIdentity()
```
    Returns true if the transform is identity. A transform is considered to be identity if the diagonal elements of its matrix is all 1s otherwise 0s.
  - copy
```
public GeneralTransform3D copy()
```
  - toString
```
public String toString()
```
    Returns the matrix elements of this transform as a string.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the matrix elements of this transform

Class GeneralTransform3D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mat

Constructor Detail

GeneralTransform3D

Method Detail

isAffine

set

set

get

get

transform

transform

transform

transform

transformNormal

transformNormal

perspective

ortho

computeClipZCoord

determinant

invert

mul

scale

mul

setIdentity

isIdentity

copy

toString