com.openinventor.meshviz.graph

Class PbDomain

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.meshviz.graph.PbBase

com.openinventor.meshviz.graph.PbDomain

All Implemented Interfaces:

java.lang.Cloneable

public class PbDomain
extends PbBase
implements java.lang.Cloneable

Class to define a domain. This class is used to define a 2D/3D domain. It is the reference of all Graph Master & 3D Data Master nodekits classes and some fields of these classes are expressed in a domain.

The domain usually defines the data coordinate limits of graphics to be generated. Graph Master & 3D Data Master do not calculate these limits, so this class provides them. In conceptual terms, a 2D domain (3D domain) is the smallest rectangle (parallelepiped) capable of containing the data for the image to be generated. The sides of this rectangle (parallelepiped) are parallel to the axis.Furthermore all Graph Master & 3D Data Master nodekits classes may be transformed according to the domain which they refer to.

There are five possible transformations (we note dx = xmax - xmin, dy = ymax - ymin and dz = zmax - zmin, xmin, ymin,..., zmax are the limits of the domain):

• The transformation is a scaling and a translation (all representations are drawn between [0-1] x [0-1] x ([0-1])). (type of transformation = TRANSFORM_01).
• All representations are scaled with scaling factors x = 1, y = dx/dy, z = dx/dz. (type of transformation = SCALE_X_FIXED).
• All representations are scaled with scaling factors x = dy/dx, y =1, z = dy/dz. (type of transformation = SCALE_Y_FIXED).
• All representations are scaled with scaling factors x = dz/dx, y = dz/dy, z = 1. (type of transformation = SCALE_Z_FIXED).
• One of scale 2,3,4 is applied according to the max(dx,dy,dz). (type of transformation = SCALE_MAX_XYZ_FIXED).

Except the first transformation type, the others compute a scaling only if the domain is heterogeneous.

All methods concerning 2D domain, set the value zmin to 0 and the value zmax to 1. By default xmin = ymin = zmin = 0, xmax = ymax = zmax = 1 and the type of transformation is SCALE_X_FIXED.

Data given by the user to define the coordinates of the domain (xmin, ymin, zmin, xmax,...) can be interpreted if the user wants to. The interpretation of these data depends on the value of the last attribute (of type BoundingBoxType) of each method for setting domain coordinates. Values for this attribute can be :

• AS_IS: Data are not interpreted. This is the default value.
• MIN_BOUNDING_CUBE: The miminum bounding square(2D domain)/cube(3D domain) is computed from the user data to set the domain coordinates.
• MAX_BOUNDED_CUBE: The maximum bounded square(2D domain)/cube(3D domain) is computed from the user data to set the domain coordinates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PbDomain.BoundingBoxTypes Bounding box interpretation.
static class	PbDomain.TransformTypes Transform type.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	AS_IS Deprecated. Use PbDomain.BoundingBoxTypes.AS_IS instead.
static int	MAX_BOUNDED_CUBE Deprecated. Use PbDomain.BoundingBoxTypes.MAX_BOUNDED_CUBE instead.
static int	MIN_BOUNDING_CUBE Deprecated. Use PbDomain.BoundingBoxTypes.MIN_BOUNDING_CUBE instead.
static int	SCALE_MAX_XYZ_FIXED Deprecated. Use PbDomain.TransformTypes.SCALE_MAX_XYZ_FIXED instead.
static int	SCALE_X_FIXED Deprecated. Use PbDomain.TransformTypes.SCALE_X_FIXED instead.
static int	SCALE_Y_FIXED Deprecated. Use PbDomain.TransformTypes.SCALE_Y_FIXED instead.
static int	SCALE_Z_FIXED Deprecated. Use PbDomain.TransformTypes.SCALE_Z_FIXED instead.
static int	TRANSFORM_01 Deprecated. Use PbDomain.TransformTypes.TRANSFORM_01 instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
PbDomain() Default constructor.
PbDomain(float xmin, float ymin, float xmax, float ymax) Calls PbDomain(xmin, ymin, xmax, ymax, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).
PbDomain(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax) Calls PbDomain(xmin, ymin, zmin, xmax, ymax, zmax, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).
PbDomain(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax, PbDomain.BoundingBoxTypes type) Constructor of a 3D domain.
PbDomain(float xmin, float ymin, float xmax, float ymax, PbDomain.BoundingBoxTypes type) Constructor of a 2D domain.
PbDomain(PbDomain domain) Copy constructor.
PbDomain(SbBox2f box) Calls PbDomain(box, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).
PbDomain(SbBox2f box, PbDomain.BoundingBoxTypes type) Constructor of a 2D domain.
PbDomain(SbBox3f box) Calls PbDomain(box, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).
PbDomain(SbBox3f box, PbDomain.BoundingBoxTypes type) Constructor of a 3D domain.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
SbBox2f	get2DDomain() Gets the 2D domain.
SbBox3f	get3DDomain() Gets the 3D domain.
SbMatrix	getMatrix() Get the domain transform matrix in an SbMatrix object.
SoMatrixTransform	getMatrixTransform() Get the domain transform matrix in an SoMatrixTransform object.
SoTransform	getTransform() Get the domain transform matrix in an SoTransform object.
PbDomain.TransformTypes	getTransformType() Gets the type of transformation.
void	setDomain(float xmin, float ymin, float xmax, float ymax) Calls setDomain(xmin, ymin, xmax, ymax, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).
void	setDomain(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax) Calls setDomain(xmin, ymin, zmin, xmax, ymax, zmax, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).
void	setDomain(float xmin, float ymin, float zmin, float xmax, float ymax, float zmax, PbDomain.BoundingBoxTypes type) Sets a 3D domain.
void	setDomain(float xmin, float ymin, float xmax, float ymax, PbDomain.BoundingBoxTypes type) Sets a 2D domain.
void	setDomain(SbBox2f box) Calls setDomain(box, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).
void	setDomain(SbBox2f box, PbDomain.BoundingBoxTypes type) Sets a 2D domain.
void	setDomain(SbBox3f box) Calls setDomain(box, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).
void	setDomain(SbBox3f box, PbDomain.BoundingBoxTypes type) Sets a 3D domain.
void	setTransformType(PbDomain.TransformTypes type) Sets the type of transformation.

Methods inherited from class com.openinventor.meshviz.graph.PbBase

enableConnection, isConnectionEnabled, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRANSFORM_01

@Deprecated
public static final int TRANSFORM_01

Deprecated. Use PbDomain.TransformTypes.TRANSFORM_01 instead.

SCALE_X_FIXED

@Deprecated
public static final int SCALE_X_FIXED

Deprecated. Use PbDomain.TransformTypes.SCALE_X_FIXED instead.

SCALE_Y_FIXED

@Deprecated
public static final int SCALE_Y_FIXED

Deprecated. Use PbDomain.TransformTypes.SCALE_Y_FIXED instead.

SCALE_Z_FIXED

@Deprecated
public static final int SCALE_Z_FIXED

Deprecated. Use PbDomain.TransformTypes.SCALE_Z_FIXED instead.

SCALE_MAX_XYZ_FIXED

@Deprecated
public static final int SCALE_MAX_XYZ_FIXED

Deprecated. Use PbDomain.TransformTypes.SCALE_MAX_XYZ_FIXED instead.

AS_IS

@Deprecated
public static final int AS_IS

Deprecated. Use PbDomain.BoundingBoxTypes.AS_IS instead.

MIN_BOUNDING_CUBE

@Deprecated
public static final int MIN_BOUNDING_CUBE

Deprecated. Use PbDomain.BoundingBoxTypes.MIN_BOUNDING_CUBE instead.

MAX_BOUNDED_CUBE

@Deprecated
public static final int MAX_BOUNDED_CUBE

Deprecated. Use PbDomain.BoundingBoxTypes.MAX_BOUNDED_CUBE instead.

Constructor Detail

PbDomain

public PbDomain(SbBox2f box)

Calls PbDomain(box, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).

PbDomain

public PbDomain(SbBox3f box)

Calls PbDomain(box, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).

PbDomain

public PbDomain(float xmin,
                float ymin,
                float xmax,
                float ymax)

Calls PbDomain(xmin, ymin, xmax, ymax, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).

PbDomain

public PbDomain(float xmin,
                float ymin,
                float zmin,
                float xmax,
                float ymax,
                float zmax)

Calls PbDomain(xmin, ymin, zmin, xmax, ymax, zmax, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).

PbDomain

public PbDomain(float xmin,
                float ymin,
                float zmin,
                float xmax,
                float ymax,
                float zmax,
                PbDomain.BoundingBoxTypes type)

Constructor of a 3D domain.

PbDomain

public PbDomain(float xmin,
                float ymin,
                float xmax,
                float ymax,
                PbDomain.BoundingBoxTypes type)

Constructor of a 2D domain.

PbDomain

public PbDomain()

Default constructor.

PbDomain

public PbDomain(PbDomain domain)

Copy constructor.

PbDomain

public PbDomain(SbBox3f box,
                PbDomain.BoundingBoxTypes type)

Constructor of a 3D domain.

PbDomain

public PbDomain(SbBox2f box,
                PbDomain.BoundingBoxTypes type)

Constructor of a 2D domain.

Method Detail

setDomain

public void setDomain(SbBox2f box)

Calls setDomain(box, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).

setDomain

public void setDomain(float xmin,
                      float ymin,
                      float xmax,
                      float ymax)

Calls setDomain(xmin, ymin, xmax, ymax, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).

setDomain

public void setDomain(float xmin,
                      float ymin,
                      float zmin,
                      float xmax,
                      float ymax,
                      float zmax)

Calls setDomain(xmin, ymin, zmin, xmax, ymax, zmax, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).

setDomain

public void setDomain(SbBox3f box)

Calls setDomain(box, PbDomain.BoundingBoxTypes.valueOf( PbDomain.BoundingBoxTypes.AS_IS.getValue() )).

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

setDomain

public void setDomain(float xmin,
                      float ymin,
                      float xmax,
                      float ymax,
                      PbDomain.BoundingBoxTypes type)

Sets a 2D domain.

setDomain

public void setDomain(float xmin,
                      float ymin,
                      float zmin,
                      float xmax,
                      float ymax,
                      float zmax,
                      PbDomain.BoundingBoxTypes type)

Sets a 3D domain.

getMatrixTransform

public SoMatrixTransform getMatrixTransform()

Get the domain transform matrix in an SoMatrixTransform object.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getTransformType

public PbDomain.TransformTypes getTransformType()

Gets the type of transformation.

getMatrix

public SbMatrix getMatrix()

Get the domain transform matrix in an SbMatrix object.

getTransform

public SoTransform getTransform()

Get the domain transform matrix in an SoTransform object.

setTransformType

public void setTransformType(PbDomain.TransformTypes type)

Sets the type of transformation. (SCALE_X_FIXED by default)

setDomain

public void setDomain(SbBox3f box,
                      PbDomain.BoundingBoxTypes type)

Sets a 3D domain.

setDomain

public void setDomain(SbBox2f box,
                      PbDomain.BoundingBoxTypes type)

Sets a 2D domain.

get3DDomain

public SbBox3f get3DDomain()

Gets the 3D domain.

get2DDomain

public SbBox2f get2DDomain()

Gets the 2D domain.