PoDomain Class Reference

Node to define a domain. More...

#include <MeshViz/nodes/PoDomain.h>

Inheritance diagram for PoDomain:

Public Types
enum	TransformType {   TRANSFORM_01 ,   SCALE_X_FIXED ,   SCALE_Y_FIXED ,   SCALE_Z_FIXED ,   SCALE_MAX_XYZ_FIXED }
	Transform type. More...
enum	BoundingBoxType {   AS_IS ,   MIN_BOUNDING_CUBE ,   MAX_BOUNDED_CUBE }
	Bounding box interpretation. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
void	setValues (const SbVec2f &min, const SbVec2f &max, BoundingBoxType type=AS_IS)
	Convenience method to define a 2D domain.
void	setValues (const SbVec3f &min, const SbVec3f &max, BoundingBoxType type=AS_IS)
	Convenience method to define a 3D domain.
SoTransform *	getTransform ()
	Get the domain transform matrix in an SoTransform object.
SoMatrixTransform *	getMatrixTransform ()
	Get the domain transform matrix in an SbMatrix object.
	PoDomain ()
	Constructor.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from PoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFVec3f	min
	Define the minimum of the domain.
SoSFVec3f	max
	Define the maximum of the domain.
SoSFEnum	transformType
	Define the transformation type of the domain.

Detailed Description

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

}

Definition at line 105 of file PoDomain.h.

Member Enumeration Documentation

BoundingBoxType

enum PoDomain::BoundingBoxType

Bounding box interpretation.

Enumerator
AS_IS
MIN_BOUNDING_CUBE
MAX_BOUNDED_CUBE

Definition at line 126 of file PoDomain.h.

TransformType

enum PoDomain::TransformType

Transform type.

Enumerator
TRANSFORM_01
SCALE_X_FIXED
SCALE_Y_FIXED
SCALE_Z_FIXED
SCALE_MAX_XYZ_FIXED

Definition at line 115 of file PoDomain.h.

Constructor & Destructor Documentation

PoDomain()

PoDomain::PoDomain

(

)

Constructor.

Member Function Documentation

getClassTypeId()

static SoType PoDomain::getClassTypeId ( )

static

Returns the type identifier for this class.

getMatrixTransform()

SoMatrixTransform * PoDomain::getMatrixTransform

(

)

Get the domain transform matrix in an SbMatrix object.

getTransform()

SoTransform * PoDomain::getTransform

(

)

Get the domain transform matrix in an SoTransform object.

getTypeId()

virtual SoType PoDomain::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from PoNode.

setValues() [1/2]

void PoDomain::setValues	(	const SbVec2f &	min,
		const SbVec2f &	max,
		BoundingBoxType	type = AS_IS
	)

Convenience method to define a 2D domain.

setValues() [2/2]

void PoDomain::setValues	(	const SbVec3f &	min,
		const SbVec3f &	max,
		BoundingBoxType	type = AS_IS
	)

Convenience method to define a 3D domain.

Member Data Documentation

max

SoSFVec3f PoDomain::max

Define the maximum of the domain.

Definition at line 144 of file PoDomain.h.

min

SoSFVec3f PoDomain::min

Define the minimum of the domain.

Definition at line 139 of file PoDomain.h.

transformType

SoSFEnum PoDomain::transformType

Define the transformation type of the domain.

Definition at line 149 of file PoDomain.h.

---

The documentation for this class was generated from the following file:

• MeshViz/nodes/PoDomain.h