com.openinventor.meshviz.nodes

Class PoDomain

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.meshviz.nodes.PoNode

com.openinventor.meshviz.nodes.PoDomain

All Implemented Interfaces:

SafeDisposable

public class PoDomain
extends PoNode

Node to define a domain. This node defines the current domain for all subsequent MeshViz representations. This class is used to define a 2D/3D 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 depend on.

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.

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.

NOTE: PoDomain is effectively a transform node, but ONLY affects MeshViz nodes. If you want the PoDomain transform to apply to other geometry, use the getTransform() method to get an SoTransform node and insert that node in the scene graph above the other geometry.

File format/default:

PoDomain {

min	0 0 0
max	1 1 1
transformType	SCALE_X_FIXED

}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PoDomain.BoundingBoxTypes Bounding box interpretation.
static class	PoDomain.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 PoDomain.BoundingBoxTypes.AS_IS instead.
SoSFVec3f	max Define the maximum of the domain.
static int	MAX_BOUNDED_CUBE Deprecated. Use PoDomain.BoundingBoxTypes.MAX_BOUNDED_CUBE instead.
SoSFVec3f	min Define the minimum of the domain.
static int	MIN_BOUNDING_CUBE Deprecated. Use PoDomain.BoundingBoxTypes.MIN_BOUNDING_CUBE instead.
static int	SCALE_MAX_XYZ_FIXED Deprecated. Use PoDomain.TransformTypes.SCALE_MAX_XYZ_FIXED instead.
static int	SCALE_X_FIXED Deprecated. Use PoDomain.TransformTypes.SCALE_X_FIXED instead.
static int	SCALE_Y_FIXED Deprecated. Use PoDomain.TransformTypes.SCALE_Y_FIXED instead.
static int	SCALE_Z_FIXED Deprecated. Use PoDomain.TransformTypes.SCALE_Z_FIXED instead.
static int	TRANSFORM_01 Deprecated. Use PoDomain.TransformTypes.TRANSFORM_01 instead.
SoSFEnum<PoDomain.TransformTypes>	transformType Define the transformation type of the domain.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
PoDomain() Constructor.

Method Summary

Modifier and Type	Method and Description
SoMatrixTransform	getMatrixTransform() Get the domain transform matrix in an SbMatrix object.
SoTransform	getTransform() Get the domain transform matrix in an SoTransform object.
void	setValues(SbVec2f min, SbVec2f max) Calls setValues(min, max, PoDomain.BoundingBoxTypes.valueOf( PoDomain.BoundingBoxTypes.AS_IS.getValue() )).
void	setValues(SbVec2f min, SbVec2f max, PoDomain.BoundingBoxTypes type) Convenience method to define a 2D domain.
void	setValues(SbVec3f min, SbVec3f max) Calls setValues(min, max, PoDomain.BoundingBoxTypes.valueOf( PoDomain.BoundingBoxTypes.AS_IS.getValue() )).
void	setValues(SbVec3f min, SbVec3f max, PoDomain.BoundingBoxTypes type) Convenience method to define a 3D domain.

Methods inherited from class com.openinventor.meshviz.nodes.PoNode

callback, doAction, getBoundingBox, getMatrix, getPrimitiveCount, GLRender, handleEvent, pick, search, write

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, copy, copy, distribute, getAlternateRep, getByName, getRenderUnitID, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, isBoundingBoxIgnoring, isOverride, rayPick, setOverride, touch

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

TRANSFORM_01

@Deprecated
public static final int TRANSFORM_01

Deprecated. Use PoDomain.TransformTypes.TRANSFORM_01 instead.

SCALE_X_FIXED

@Deprecated
public static final int SCALE_X_FIXED

Deprecated. Use PoDomain.TransformTypes.SCALE_X_FIXED instead.

SCALE_Y_FIXED

@Deprecated
public static final int SCALE_Y_FIXED

Deprecated. Use PoDomain.TransformTypes.SCALE_Y_FIXED instead.

SCALE_Z_FIXED

@Deprecated
public static final int SCALE_Z_FIXED

Deprecated. Use PoDomain.TransformTypes.SCALE_Z_FIXED instead.

SCALE_MAX_XYZ_FIXED

@Deprecated
public static final int SCALE_MAX_XYZ_FIXED

Deprecated. Use PoDomain.TransformTypes.SCALE_MAX_XYZ_FIXED instead.

AS_IS

@Deprecated
public static final int AS_IS

Deprecated. Use PoDomain.BoundingBoxTypes.AS_IS instead.

MIN_BOUNDING_CUBE

@Deprecated
public static final int MIN_BOUNDING_CUBE

Deprecated. Use PoDomain.BoundingBoxTypes.MIN_BOUNDING_CUBE instead.

MAX_BOUNDED_CUBE

@Deprecated
public static final int MAX_BOUNDED_CUBE

Deprecated. Use PoDomain.BoundingBoxTypes.MAX_BOUNDED_CUBE instead.

min

public final SoSFVec3f min

Define the minimum of the domain.

max

public final SoSFVec3f max

Define the maximum of the domain.

transformType

public final SoSFEnum<PoDomain.TransformTypes> transformType

Define the transformation type of the domain.

Constructor Detail

PoDomain

public PoDomain()

Constructor.

Method Detail

setValues

public void setValues(SbVec3f min,
                      SbVec3f max)

Calls setValues(min, max, PoDomain.BoundingBoxTypes.valueOf( PoDomain.BoundingBoxTypes.AS_IS.getValue() )).

setValues

public void setValues(SbVec2f min,
                      SbVec2f max)

Calls setValues(min, max, PoDomain.BoundingBoxTypes.valueOf( PoDomain.BoundingBoxTypes.AS_IS.getValue() )).

setValues

public void setValues(SbVec2f min,
                      SbVec2f max,
                      PoDomain.BoundingBoxTypes type)

Convenience method to define a 2D domain.

setValues

public void setValues(SbVec3f min,
                      SbVec3f max,
                      PoDomain.BoundingBoxTypes type)

Convenience method to define a 3D domain.

getTransform

public SoTransform getTransform()

Get the domain transform matrix in an SoTransform object.

getMatrixTransform

public SoMatrixTransform getMatrixTransform()

Get the domain transform matrix in an SbMatrix object.