SoCSGShape Class

SoCSGShape Class

Shape defined by a binary boolean operation on two sub scene graphs.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.InventorSoDisposable
      OIV.Inventor.MiscSoBase
        OIV.Inventor.FieldsSoFieldContainer
          OIV.Inventor.NodesSoNode
            OIV.Inventor.NodesSoShape
              OIV.Inventor.NodesSoCSGShape

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public class SoCSGShape : SoShape

Public Class SoCSGShape
	Inherits SoShape

public ref class SoCSGShape : public SoShape

type SoCSGShape =  
    class
        inherit SoShape
    end

The SoCSGShape type exposes the following members.

Constructors

	Name	Description
	SoCSGShape	Constructor.

Top

Methods

	Name	Description
	AffectsState	Overrides default method on OIV.Inventor.Nodes.SoNode. (Inherited from SoShape.)
	BeginShape(SoAction, SoShapeTriangleShapes)	Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr). (Inherited from SoShape.)
	BeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail)	These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type. (Inherited from SoShape.)
	Callback	Implements primitive generation for all shapes. (Overrides SoShapeCallback(SoCallbackAction).)
	ComputeBBox(SoAction, SbBox3f, SbVec3f)	Compute axis aligned bounding box (AABB) for subclass using information in the given action (which may not necessarily be an OIV.Inventor.Actions.SoGetBoundingBoxAction). (Overrides SoShapeComputeBBox(SoAction, SbBox3f, SbVec3f).)
	ComputeBBox(SoAction, SbXfBox3d, SbVec3d)	Compute axis aligned bounding box (AABB) for subclass using information in the given action (which may not necessarily be an OIV.Inventor.Actions.SoGetBoundingBoxAction). (Overrides SoShapeComputeBBox(SoAction, SbXfBox3d, SbVec3d).)
	Copy	Calls Copy(false). (Inherited from SoNode.)
	Copy(Boolean)	Creates and returns an exact copy of the node. (Inherited from SoNode.)
	CopyFieldValues(SoFieldContainer)	Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.)
	CopyFieldValues(SoFieldContainer, Boolean)	Copies the contents of fc's fields into this object's fields. (Inherited from SoFieldContainer.)
	Dispose	Releases all resources used by SoDisposable. (Inherited from SoDisposable.)
	Distribute	(Inherited from SoNode.)
	DoAction	(Overrides SoNodeDoAction(SoAction).)
	EnableNotify	Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). (Inherited from SoFieldContainer.)
	EndShape	end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). (Inherited from SoShape.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FieldsAreEqual	Returns true if this object's fields are exactly equal to fc's fields. (Inherited from SoFieldContainer.)
	Get	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. (Inherited from SoFieldContainer.)
	GetAllFields	Returns a list of fields, including the eventIn's and eventOut's. (Inherited from SoFieldContainer.)
	GetAlternateRep	This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). (Inherited from SoNode.)
	GetBoundingBox	Implements bounding box method using virtual OIV.Inventor.Nodes.SoShape.ComputeBBox(OIV.Inventor.Actions.SoAction, OIV.Inventor.SbBox3f@, OIV.Inventor.SbVec3f@) method. (Inherited from SoShape.)
	GetEventIn	Returns a the eventIn with the given name. (Inherited from SoFieldContainer.)
	GetEventOut	Returns the eventOut with the given name. (Inherited from SoFieldContainer.)
	GetField	Returns a the field of this object whose name is fieldName. (Inherited from SoFieldContainer.)
	GetFieldName	Returns the name of the given field in the fieldName argument. (Inherited from SoFieldContainer.)
	GetFields	Appends references to all of this object's fields to resultList, and returns the number of fields appended. (Inherited from SoFieldContainer.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetMatrix	(Inherited from SoNode.)
	GetName	Returns the name of an instance. (Inherited from SoBase.)
	GetPrimitiveCount	Counts number of primitives produced by this shape. (Overrides SoShapeGetPrimitiveCount(SoGetPrimitiveCountAction).)
	GetRenderEngineMode	Returns the supported Render engine mode. (Inherited from SoNode.)
	GetRenderUnitID	(Inherited from SoNode.)
	GetShapeType	Gets the current shape Full Scene Antialiasing type. (Inherited from SoShape.)
	GetStatus	Returns status of csg operation.
	GetStringName	(Inherited from SoBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GLRender	Implements rendering by rendering each primitive generated by subclass. (Overrides SoShapeGLRender(SoGLRenderAction).)
	GLRenderBelowPath	(Inherited from SoNode.)
	GLRenderInPath	(Inherited from SoNode.)
	GLRenderOffPath	(Inherited from SoNode.)
	GrabEventsCleanup	(Inherited from SoNode.)
	GrabEventsSetup	(Inherited from SoNode.)
	HandleEvent	(Inherited from SoNode.)
	HasDefaultValues	Returns true if all of the object's fields have their default values. (Inherited from SoFieldContainer.)
	IsBoundingBoxIgnoring	Used by BoundingBoxAction to know if bounding box computation should be ignored or not. (Inherited from SoShape.)
	IsNotifyEnabled	Notification is the process of telling interested objects that this object has changed. (Inherited from SoFieldContainer.)
	IsOverride	Returns the state of the override flag. (Inherited from SoNode.)
	IsSynchronizable	Gets the ScaleViz synchronizable state of this object. (Inherited from SoBase.)
	Pick	(Inherited from SoNode.)
	RayPick	Implements picking along a ray by intersecting the ray with each primitive generated by subclass. (Overrides SoShapeRayPick(SoRayPickAction).)
	Search	(Inherited from SoNode.)
	Set	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. (Inherited from SoFieldContainer.)
	SetMaxAttempt	If the CSG Operation failed for any reason, it will be retried by applying a small random transformation to the operand vertices.
	SetName	(Inherited from SoBase.)
	SetOverride	Turns the override flag on or off. (Inherited from SoNode.)
	SetRescueOperation	Set operation to use if the CSG operation fails or CSGLib is not available.
	SetShapeType	set the antialiasing type for this shape. (Inherited from SoShape.)
	SetSynchronizable	Sets this to be a ScaleViz synchronizable object. (Inherited from SoBase.)
	SetToDefaults	Sets all fields in this object to their default values. (Inherited from SoFieldContainer.)
	ShapeVertex	add a primitive vertex to the shape prevously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). (Inherited from SoShape.)
	ToString	Converts this SoBase structure to a human readable string. (Inherited from SoBase.)
	Touch	Marks an instance as modified, simulating a change to it. (Inherited from SoNode.)
	Write	(Inherited from SoNode.)

Top

Properties

	Name	Description
	boundingBoxIgnoring	Whether to ignore this node during bounding box traversal. (Inherited from SoShape.)
	csgOperation	CSG boolean operation to apply.
	IsDisposable	ISafeDisposable interface implementation. (Inherited from SoDisposable.)
	leftOperand	Geometry scene graph to be used as left operand for the Boolean operation.
	rightOperand	Geometry scene graph to be used as right operand for the Boolean operation.
	UserData	Gets or sets the user data to be contained by the field container. (Inherited from SoFieldContainer.)

Top

Remarks

This shape represents the result of a Constructive Solid Geometry (CSG) operation applied on the two scene graphs OIV.Inventor.Nodes.SoCSGShape.leftOperand and OIV.Inventor.Nodes.SoCSGShape.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 OIV.Inventor.Nodes.SoCSGShape nodes. You can define a complex CSG geometry by creating a tree using multiple OIV.Inventor.Nodes.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 (OIV.Inventor.Nodes.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 OIV.Inventor.Nodes.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.

Note
Node available since Open Inventor 8.6 FILE FORMAT/DEFAULT

Note

Node available 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 OIV.Inventor.Nodes.SoCSGShape. The shader will be applied to the result of the CSG operation.

Reference

OIV.Inventor.Nodes Namespace

OIV.Inventor.Nodes.SoShape