com.openinventor.meshviz.graph

Class PoBase

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodekits.SoBaseKit

com.openinventor.meshviz.graph.PoBase

All Implemented Interfaces:

SafeDisposable, SoGetView

Direct Known Subclasses:

Po3DdataMaster, PoGraphMaster

public class PoBase
extends SoBaseKit

Abstract base class for all Graph Master & 3D Data Master classes. All representations depend on the current domain which defines the data limits of the graphic to be generated. If the method setDomain(domain) is called, the current domain is "domain". Otherwise the current domain is specified in the current inherited state (cf property node PoDomain).

Be careful, do not use the method rebuild() if you use MeshViz property nodes (PoDomain, PoMeshProperty,...), because a representation (axis, legend, 2D and 3D mesh representation,..) depends on the current inherited state. If you need to do an extra work after a representation has been built, do it in a post-rebuild callback (cf PoBase.addPostRebuildCallback).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PoBase.NodeWriteFormats Type of write format.
static class	PoBase.TextTypes Type of Text.
static class	PoBase.UpdateMethodTypes Type of update method.

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	FOLD_NODE_WRITE_FORMAT Deprecated. Use PoBase.NodeWriteFormats.FOLD_NODE_WRITE_FORMAT instead.
static int	SO_ANNO_TEXT3 Deprecated. Use PoBase.TextTypes.SO_ANNO_TEXT3 instead.
static int	SO_TEXT3 Deprecated. Use PoBase.TextTypes.SO_TEXT3 instead.
static int	UNFOLD_NODE_WRITE_FORMAT Deprecated. Use PoBase.NodeWriteFormats.UNFOLD_NODE_WRITE_FORMAT instead.
static int	UPDATE_METHOD_IMMEDIATE Deprecated. Use PoBase.UpdateMethodTypes.UPDATE_METHOD_IMMEDIATE instead.
static int	UPDATE_METHOD_ON_ACTION Deprecated. Use PoBase.UpdateMethodTypes.UPDATE_METHOD_ON_ACTION instead.

Fields inherited from class com.openinventor.inventor.nodekits.SoBaseKit

boundingBoxIgnoring

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Method Summary

Modifier and Type	Method and Description
void	addPostRebuildCallback(PoRebuildCB cb, java.lang.Object data) Add a callback function to call when the node kit is rebuilt.
void	addPreRebuildCallback(PoRebuildCB cb, java.lang.Object data) Add a callback function to call when the node kit is rebuilt.
static SoNodekitCatalog	getClassNodekitCatalog() Returns the SoNodekitCatalog for this class.
PbDomain	getDomain() Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
static PoBase.NodeWriteFormats	getNodeWriteFormat() Gets the node write format.
static PoBase.TextTypes	getTextType() Gets the type of text used.
PoBase.UpdateMethodTypes	getUpdateMethod() Gets update method.
boolean	isBuilt() Indicates if the node kit has been built at least once.
boolean	isModified() Return true, if the kit has been modified, else otherwise.
static boolean	isVRML2Mode() Gets the VRML2 mode (true = VRML2 mode, false Inventor mode)
void	rebuild() Forces the node kit to be rebuilt immediately.
void	setDomain(PbDomain dom) Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated.
static void	setNodeWriteFormat(PoBase.NodeWriteFormats format) Sets the node write format.
static void	setTextType(PoBase.TextTypes type) Sets the type of text used.
void	setUpdateMethod(PoBase.UpdateMethodTypes type) Sets scene graph update method.
static void	setVRML2Mode(boolean flag) Set the VRML2 mode.
void	touchKit() Indicates the node kit is modified.

Methods inherited from class com.openinventor.inventor.nodekits.SoBaseKit

getNodekitCatalog, getPart, getPart, getPartString, getViewportIsEnabled, getViewportOrigin, getViewportSize, isSearchingChildren, set, set, setPart, setSearchingChildren

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

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

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

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, 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

UPDATE_METHOD_IMMEDIATE

@Deprecated
public static final int UPDATE_METHOD_IMMEDIATE

Deprecated. Use PoBase.UpdateMethodTypes.UPDATE_METHOD_IMMEDIATE instead.

UPDATE_METHOD_ON_ACTION

@Deprecated
public static final int UPDATE_METHOD_ON_ACTION

Deprecated. Use PoBase.UpdateMethodTypes.UPDATE_METHOD_ON_ACTION instead.

FOLD_NODE_WRITE_FORMAT

@Deprecated
public static final int FOLD_NODE_WRITE_FORMAT

Deprecated. Use PoBase.NodeWriteFormats.FOLD_NODE_WRITE_FORMAT instead.

UNFOLD_NODE_WRITE_FORMAT

@Deprecated
public static final int UNFOLD_NODE_WRITE_FORMAT

Deprecated. Use PoBase.NodeWriteFormats.UNFOLD_NODE_WRITE_FORMAT instead.

SO_TEXT3

@Deprecated
public static final int SO_TEXT3

Deprecated. Use PoBase.TextTypes.SO_TEXT3 instead.

SO_ANNO_TEXT3

@Deprecated
public static final int SO_ANNO_TEXT3

Deprecated. Use PoBase.TextTypes.SO_ANNO_TEXT3 instead.

Method Detail

addPreRebuildCallback

public void addPreRebuildCallback(PoRebuildCB cb,
                                  java.lang.Object data)

Add a callback function to call when the node kit is rebuilt. This callback is called just before the kit is rebuilt.

addPostRebuildCallback

public void addPostRebuildCallback(PoRebuildCB cb,
                                   java.lang.Object data)

Add a callback function to call when the node kit is rebuilt. This callback is called just after the kit is rebuilt.

setTextType

public static void setTextType(PoBase.TextTypes type)

Sets the type of text used. Possible values :

• type = SO_TEXT3 : All texts used for representations are SoText3 nodes.
• type = SO_ANNO_TEXT3 : All text used for representations are SoAnnoText3 (this type of text has more attributes than SoText3 which can be specified with the property node SoAnnoText3Property).

type = SO_ANNO_TEXT3 by default.

getTextType

public static PoBase.TextTypes getTextType()

Gets the type of text used.

setVRML2Mode

public static void setVRML2Mode(boolean flag)

Set the VRML2 mode. This mode allows the user to configure MeshViz to prepare the conversion in VRML2 format with the best possible result. In this way, MeshViz realizes some particular actions :

• Whatever text type specified by the method setTextType(), all texts used are SoAsciiText in order to minimize VRML2 file size (other text types are tessellated during a VRML2 conversion which increases VRML2 file size).
• For all materials generated by MeshViz where the light model is SoLightModel.BASE_COLOR (There is no equivalence in VRML2), the emissive component is set at the same value as the diffuse components (By this way, we simulate SoLightModel.BASE_COLOR light model).
• A Z Offset is added for all coplanar faces generated by MeshViz representation (All these representations are planar as for instance legends so the SoAnnotation node solves their problems, but there is no equivalence in VRML2).

This mode is inactive by default.

getNodeWriteFormat

public static PoBase.NodeWriteFormats getNodeWriteFormat()

Gets the node write format. See setNodeWriteFormat for more details.

isBuilt

public boolean isBuilt()

Indicates if the node kit has been built at least once.

getClassNodekitCatalog

public static SoNodekitCatalog getClassNodekitCatalog()

Returns the SoNodekitCatalog for this class.

setNodeWriteFormat

public static void setNodeWriteFormat(PoBase.NodeWriteFormats format)

Sets the node write format. FOLD_NODE_WRITE_FORMAT indicates that all nodes will not be unfolded when they are written with a SoWriteAction. UNFOLD_NODE_WRITE_FORMAT indicates on the contrary, that all nodes will be unfolded when they are written with a SoWriteAction. This format may be useful if you want to convert the generated file into a VRML format. Be careful, when using the format FOLD_NODE_WRITE_FORMAT, the basic objects (Pb objects) are not written in .iv file. In this case (and if you need to save this information), use the corresponding property node (for instance, replace the PbDomain object with the PoDomain property node).

(FOLD_NODE_WRITE_FORMAT by default).

isVRML2Mode

public static boolean isVRML2Mode()

Gets the VRML2 mode (true = VRML2 mode, false Inventor mode)

setDomain

public void setDomain(PbDomain dom)

Sets a reference to a PbDomain object used to define the data limits of the graphics to be generated. If this method is not called (or called passing NULL as argument), this is the domain defined in the current inherited state (defined with the node PoDomain) which is used.

getDomain

public PbDomain getDomain()

Gets a reference to a PbDomain object used to define the data limits of the graphics to be generated.

touchKit

public void touchKit()

Indicates the node kit is modified. (Simulates a change).

getUpdateMethod

public PoBase.UpdateMethodTypes getUpdateMethod()

Gets update method. See setUpdateMethod for more details.

isModified

public boolean isModified()

Return true, if the kit has been modified, else otherwise.

rebuild

public void rebuild()

Forces the node kit to be rebuilt immediately. The rebuild consists in updating all catalog parts (which contains shapes forming the visualization) of the node kit according to field values and other property values (domain, data mapping,...). Be careful, do not use the method rebuild() if you use MeshViz property nodes (PoDomain, PoMeshProperty,...), because a representation (axis, legend, 2D and 3D mesh representation,..) depends on the current inherited state. If you need to do an extra work after a representation has been built, do it in a post-rebuild callback (cf PoBase.addPostRebuildCallback).

setUpdateMethod

public void setUpdateMethod(PoBase.UpdateMethodTypes type)

Sets scene graph update method. UPDATE_METHOD_IMMEDIATE indicates that each time a Graph Master or 3D Data Master object is modified, the scene graph must be updated. UPDATE_METHOD_ON_ACTION indicates that the scene graph does not have to be modified when a Graph Master or 3D Data Master object changes; the scene graph being modified when it is necessary (before a rendering action for instance). The faster method is UPDATE_METHOD_ON_ACTION and is particularly useful for representations where more than one field has to be set to obtain the definitive representation, because with the other method, each time a field is changed, the representation is rebuilt. (UPDATE_METHOD_ON_ACTION by default).