Click or drag to resize
SoCircularExtrusion Class

Geometric shape formed by extruding a circle along a 3D spine.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoCircularExtrusion : SoBaseExtrusion

The SoCircularExtrusion type exposes the following members.

Constructors
  NameDescription
Public methodSoCircularExtrusion

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Overrides default method on OIV.Inventor.Nodes.SoNode.

(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes)
Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr).
(Inherited from SoShape.)
Public methodBeginShape(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.)
Public methodCallback

Implements primitive generation for all shapes.

(Overrides SoShapeCallback(SoCallbackAction).)
Public methodComputeBBox(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).)
Public methodComputeBBox(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).)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEndShape

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.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

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.)
Public methodGetBoundingBox

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.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount

Counts number of primitives produced by this shape.

(Overrides SoShapeGetPrimitiveCount(SoGetPrimitiveCountAction).)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShapeType

Gets the current shape Full Scene Antialiasing type.

(Inherited from SoShape.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender

Implements rendering by rendering each primitive generated by subclass.

(Inherited from SoShape.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to know if bounding box computation should be ignored or not.

(Inherited from SoShape.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick

Implements picking along a ray by intersecting the ray with each primitive generated by subclass.

(Overrides SoShapeRayPick(SoRayPickAction).)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetShapeType

set the antialiasing type for this shape.

(Inherited from SoShape.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodShapeVertex

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.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyactiveSection

Defines the visible section of the spine in normalized coordinates.

Public propertybeginCap

If true, begin planar cap surfaces generated.

(Inherited from SoBaseExtrusion.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoShape.)
Public propertyendCap

If true, end planar cap surfaces generated.

(Inherited from SoBaseExtrusion.)
Public propertyextrusionMode

Construction behavior of the extrusion.

(Inherited from SoBaseExtrusion.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyradius

Radius of the circular cross-section.

Public propertyscaleMode

Scaling behavior of the extrusion.

(Inherited from SoBaseExtrusion.)
Public propertyspine

Spine points.

(Inherited from SoBaseExtrusion.)
Public propertyspineSimplificationMode

Defines the spine simplification behavior of the extrusion.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

The OIV.Inventor.Nodes.SoCircularExtrusion node is a geometric shape based on a constant OIV.Inventor.Nodes.SoCircularExtrusion.radius circle cross section extruded along a three-dimensional polyline (spine). The circle center lies on the spine and the circle lies on the plane normal to the spine at each point. This is similar to specifying an OIV.Inventor.Nodes.SoExtrusion with a circle cross-section, which is convenient for many applications, but this node has additional advantages because it responds to the OIV.Inventor.Nodes.SoComplexity value.

The application can specify which caps are created using the fields beginCap and endCap. By default both caps are visible.

The application can specify the visible portion of the shape along the spine using normalized curvilinear coordinates (activeSection). By default the entire spine is visible.

The OIV.Inventor.Nodes.SoCircularExtrusion representation is dependent on OIV.Inventor.Nodes.SoComplexity.value. The shape is always simplified when the OIV.Inventor.Nodes.SoComplexity value is less than 1. Both the cross section (number of segments used for the circle) and the spine (number of points used for the spine) are affected by the simplification. The simplification algorithm approximates the spine by taking into account its curvature. The cross section circle is approximated by at least 10 points. With a OIV.Inventor.Nodes.SoComplexity value of 0 the extruded shape has the roughest representation.

Approximately the same geometry could be defined using an OIV.Inventor.Nodes.SoExtrusion node, but that node does not currently respond the OIV.Inventor.Nodes.SoComplexity value. Likewise the clipping behavior could be obtained using two OIV.Inventor.Nodes.SoClipPlane nodes, but OIV.Inventor.Nodes.SoCircularExtrusion uses less memory when the activeSection is a subset of the full spine. These two features make OIV.Inventor.Nodes.SoCircularExtrusion valuable when a large number of cylindrical objects must be displayed.

The scaleMode field (inherited from OIV.Inventor.Nodes.SoBaseExtrusion) is used to select the points that will be scaled by the current transformation (for example OIV.Inventor.Nodes.SoTransform), if any. Translation and rotation are applied in all cases. The options are:

  • DEFAULT : Every point in the generated geometry is scaled.

  • SPINE_ONLY : Only the spine points are scaled. The cross section points are not scaled, so the cross section shape is undistorted even is scaling is non-uniform.

  • SECTION_ONLY : Only the cross section points are scaled. Not currently implemented.

  • NONE : OIV.Inventor.Nodes.SoExtrusion ignores the scaling state. Not currently implemented.

The extrusionMode field (inherited from OIV.Inventor.Nodes.SoBaseExtrusion) is used to select the extrusion algorithm.

Limitations: The spine polyline segments must be C0 continous, that is, the spine must be connected at joints. The following segments may be C1 discontinous but be aware that very narrow angles between consecutive polyline semgments can produce odd results with SMOOTH extrusionMode modes. This is especially noticeable when the angles between segments are very small with respect to the OIV.Inventor.Nodes.SoCircularExtrusion.radius. In the following images the consecutive points A, B, C in the spine show one of these cases. The problem is at point B whose cross sections are abnormally large.
Spine Wireframe Shaded

Note Note

Node available since Open Inventor 8.6

FILE FORMAT/DEFAULT

CircularExtrusion {
beginCap true
endCap true
spine [ 0 0 0, 0 1 0 ]
scaleMode DEFAULT
extrusionMode SMOOTH
radius [ 1 ]
activeSection [ 0, 1 ]
}

See Also