| SoCircularExtrusion Class |
Geometric shape formed by extruding a circle along a 3D spine.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoShape
OIV.Inventor.NodesSoBaseExtrusion
OIV.Inventor.NodesSoCircularExtrusion
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoCircularExtrusion type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoCircularExtrusion | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Overrides default method on OIV.Inventor.Nodes.SoNode. |
| 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. |
| Callback | Implements primitive generation for all shapes. |
| 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). |
| 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). |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| 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). |
| EndShape | end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). |
| 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. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | Implements bounding box method using virtual OIV.Inventor.Nodes.SoShape.ComputeBBox(OIV.Inventor.Actions.SoAction, OIV.Inventor.SbBox3f@, OIV.Inventor.SbVec3f@) method. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | Counts number of primitives produced by this shape. |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetShapeType | Gets the current shape Full Scene Antialiasing type. |
| 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. |
| 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. |
| IsBoundingBoxIgnoring | Used by BoundingBoxAction to know if bounding box computation should be ignored or not. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | Implements picking along a ray by intersecting the ray with each primitive generated by subclass. |
| 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. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetShapeType | set the antialiasing type for this shape. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| 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). |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | activeSection | Defines the visible section of the spine in normalized coordinates. |
| beginCap | If true, begin planar cap surfaces generated. |
| boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| endCap | If true, end planar cap surfaces generated. |
| extrusionMode | Construction behavior of the extrusion. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| radius | Radius of the circular cross-section. |
| scaleMode | Scaling behavior of the extrusion. |
| spine | Spine points. |
| spineSimplificationMode | Defines the spine simplification behavior of the extrusion. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThe 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 |
|---|
Node available since Open Inventor 8.6 FILE FORMAT/DEFAULT |
| beginCap | true |
| endCap | true |
| spine | [ 0 0 0, 0 1 0 ] |
| scaleMode | DEFAULT |
| extrusionMode | SMOOTH |
| radius | [ 1 ] |
| activeSection | [ 0, 1 ] |
See Also