com.openinventor.inventor.nodes

Class SoCSGShape

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.nodes.SoShape

com.openinventor.inventor.nodes.SoCSGShape

All Implemented Interfaces:

SafeDisposable

public class SoCSGShape
extends SoShape

Shape defined by a binary boolean operation on two sub scene graphs. This shape represents the result of a Constructive Solid Geometry (CSG) operation applied on the two scene graphs leftOperand and rightOperand. Constructive solid geometry allows the application to create a (potentially) complex object by using Boolean operators to combine (relatively) simple objects.

The left and right operands can be any scene graph, including other SoCSGShape nodes. You can define a complex CSG geometry by creating a tree using multiple SoCSGShape nodes. The specified scene graph's shapes must be closed (no holes) and CCW-orientated (all triangles composing shapes must be counter-clockwise).

Each time an operand is modified, a CSG Operation is performed. Keep this in mind if you create a CSGTree (SoCSGShape which contains other SoCSGShapes), especially if you use associative and commutative operations (only additions or only intersections) because the result of such operations does not depend on the tree ( (A + B) + C = A + (B + C) ). In this case, try to build your tree by putting the most often modified nodes at the top of the tree.

For example, a tree optimized for modification on first node ( N1 ) will look like this:

    S
  __|__S
 |   __|__S
N1  |   __|__S
   N2  |   __|__
      N3  |     |
         N4    N5

Where S are SoCSGShape and N1, N2, ... are ordinary nodes. In this case, a modification on N1 will need only 1 csgOperation, whereas a modificaion on N5 will need 4 csgOperations to regenerate the resulting shape.

A tree optimized for random modification will try to minimize its depth:

                  S
          ________|_________
         |                  |
     ____S____          ____S____
    |         |        |         |
  __S__       N3       N4        N5
 |     |
 N1    N2

In this case, any modification will require at most 3 CSG Operations.

Since:

Open Inventor 8.6 File format/default:

CSGShape {

leftOperand	NULL
rightOperand	NULL
csgOperation	ADD

}

NOTES

• CSG means Constructive Solid Geometry.
• Some operations are not commutative (A - B) != (B - A).

LIMITATIONS Only vertices are handled in the generated shape. None of the normal, color, or texCoord properties of the left or right operands are taken into account. Shaders are also not taken in account, even vertex shaders. But note that you can use a shader above SoCSGShape. The shader will be applied to the result of the CSG operation.

See also:

SoShape

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoCSGShape.CsgOperationTypes CSG operation to be used.
static class	SoCSGShape.CsgStatus Status of CSG operation.

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoShape

SoShape.ShapeTypes

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD Deprecated. Use SoCSGShape.CsgOperationTypes.ADD instead.
static int	ALL Deprecated. Use SoCSGShape.CsgOperationTypes.ALL instead.
static int	CSG_ERROR Deprecated. Use SoCSGShape.CsgStatus.CSG_ERROR instead.
static int	CSG_LIB_NOT_AVAILABLE Deprecated. Use SoCSGShape.CsgStatus.CSG_LIB_NOT_AVAILABLE instead.
static int	CSG_NO_ERROR Deprecated. Use SoCSGShape.CsgStatus.CSG_NO_ERROR instead.
SoSFEnum<SoCSGShape.CsgOperationTypes>	csgOperation CSG boolean operation to apply.
static int	INTERSECTION Deprecated. Use SoCSGShape.CsgOperationTypes.INTERSECTION instead.
static int	LEFT_ONLY Deprecated. Use SoCSGShape.CsgOperationTypes.LEFT_ONLY instead.
SoSFNode	leftOperand Geometry scene graph to be used as left operand for the Boolean operation.
static int	NOTHING Deprecated. Use SoCSGShape.CsgOperationTypes.NOTHING instead.
static int	RIGHT_ONLY Deprecated. Use SoCSGShape.CsgOperationTypes.RIGHT_ONLY instead.
SoSFNode	rightOperand Geometry scene graph to be used as right operand for the Boolean operation.
static int	SUB Deprecated. Use SoCSGShape.CsgOperationTypes.SUB instead.

Fields inherited from class com.openinventor.inventor.nodes.SoShape

boundingBoxIgnoring, LINES, POINTS, POLYGONS, TEXT

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoCSGShape() Constructor.

Method Summary

Modifier and Type	Method and Description
SoCSGShape.CsgStatus	getStatus() Returns status of csg operation.
void	setMaxAttempt(int maxAttempt) If the CSG Operation failed for any reason, it will be retried by applying a small random transformation to the operand vertices.
static void	setRescueOperation(SoCSGShape.CsgOperationTypes op) Set operation to use if the CSG operation fails or CSGLib is not available.

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

getShapeType, isPrimitiveRestartAvailable, isPrimitiveRestartAvailable

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, 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

ADD

@Deprecated
public static final int ADD

Deprecated. Use SoCSGShape.CsgOperationTypes.ADD instead.

SUB

@Deprecated
public static final int SUB

Deprecated. Use SoCSGShape.CsgOperationTypes.SUB instead.

INTERSECTION

@Deprecated
public static final int INTERSECTION

Deprecated. Use SoCSGShape.CsgOperationTypes.INTERSECTION instead.

LEFT_ONLY

@Deprecated
public static final int LEFT_ONLY

Deprecated. Use SoCSGShape.CsgOperationTypes.LEFT_ONLY instead.

RIGHT_ONLY

@Deprecated
public static final int RIGHT_ONLY

Deprecated. Use SoCSGShape.CsgOperationTypes.RIGHT_ONLY instead.

NOTHING

@Deprecated
public static final int NOTHING

Deprecated. Use SoCSGShape.CsgOperationTypes.NOTHING instead.

ALL

@Deprecated
public static final int ALL

Deprecated. Use SoCSGShape.CsgOperationTypes.ALL instead.

CSG_NO_ERROR

@Deprecated
public static final int CSG_NO_ERROR

Deprecated. Use SoCSGShape.CsgStatus.CSG_NO_ERROR instead.

CSG_LIB_NOT_AVAILABLE

@Deprecated
public static final int CSG_LIB_NOT_AVAILABLE

Deprecated. Use SoCSGShape.CsgStatus.CSG_LIB_NOT_AVAILABLE instead.

CSG_ERROR

@Deprecated
public static final int CSG_ERROR

Deprecated. Use SoCSGShape.CsgStatus.CSG_ERROR instead.

leftOperand

public final SoSFNode leftOperand

Geometry scene graph to be used as left operand for the Boolean operation.

rightOperand

public final SoSFNode rightOperand

Geometry scene graph to be used as right operand for the Boolean operation.

csgOperation

public final SoSFEnum<SoCSGShape.CsgOperationTypes> csgOperation

CSG boolean operation to apply. . Default is ADD.

Constructor Detail

SoCSGShape

public SoCSGShape()

Constructor.

Method Detail

setMaxAttempt

public void setMaxAttempt(int maxAttempt)

If the CSG Operation failed for any reason, it will be retried by applying a small random transformation to the operand vertices. This can solve the problem if the geometries are well formed, but for example 2 faces are coplanar. This method sets the max number of times SoCSGShape will retry before giving up and using the rescueOperation (see setRescueOperation). A max attempt of 5 is enough. If CSG Operation fails after 5 attempts, it will probably fail all the time.

Default is 5.

Warning A value > 0 may change the coordinates of geometries as they will be transformed a little bit to apply the CSG operation. This transformation is normally not visible to the naked eye (it's about 0.01%), but may cause issues if you need precise values.

getStatus

public SoCSGShape.CsgStatus getStatus()

Returns status of csg operation.

Note Status is updated only when the node is traversed. Initially returns CSG_NO_ERROR. .

setRescueOperation

public static void setRescueOperation(SoCSGShape.CsgOperationTypes op)

Set operation to use if the CSG operation fails or CSGLib is not available. Default is NOTHING. Must be one of LEFT_ONLY, RIGHT_ONLY, NOTHING or ALL. .