 |
Coin
4.0.3
Coin3D core library
|
|
Coin
4.0.3
Coin3D core library
|
The SoVRMLExtrusion class is a a geometry node for extruding a cross section along a spine. More...
#include <Inventor/VRMLnodes/SoVRMLExtrusion.h>
Static Public Member Functions | |
| static SoType | getClassTypeId (void) |
| static void | initClass (void) |
 Static Public Member Functions inherited from SoVRMLGeometry | |
| static SoType | getClassTypeId (void) |
| static void | initClass (void) |
| Static Public Member Functions inherited from SoShape | |
| static SoType | getClassTypeId (void) |
| static float | getDecimatedComplexity (SoState *state, float complexity) |
| static void | getScreenSize (SoState *const state, const SbBox3f &boundingbox, SbVec2s &rectsize) |
| static void | initClass (void) |
| Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
| Static Public Member Functions inherited from SoNode | |
| static void | audioRenderS (SoAction *action, SoNode *node) |
| static void | callbackS (SoAction *action, SoNode *node) |
| static int | getActionMethodIndex (const SoType type) |
| static void | getBoundingBoxS (SoAction *action, SoNode *node) |
| static SoNode * | getByName (const SbName &name) |
| static int | getByName (const SbName &name, SoNodeList &l) |
| static SoType | getClassTypeId (void) |
| static uint32_t | getCompatibilityTypes (const SoType &nodetype) |
| static void | getMatrixS (SoAction *action, SoNode *node) |
| static SbUniqueId | getNextNodeId (void) |
| static void | getPrimitiveCountS (SoAction *action, SoNode *node) |
| static void | GLRenderS (SoAction *action, SoNode *node) |
| static void | handleEventS (SoAction *action, SoNode *node) |
| static void | initClass (void) |
| Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
| static void | initClasses (void) |
| static void | pickS (SoAction *action, SoNode *node) |
| static void | rayPickS (SoAction *action, SoNode *node) |
| static void | searchS (SoAction *action, SoNode *node) |
| static void | writeS (SoAction *action, SoNode *node) |
| Static Public Member Functions inherited from SoFieldContainer | |
| static void | addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) |
| static SoFieldContainer * | checkCopy (const SoFieldContainer *orig) |
| static void | cleanupClass (void) |
| static void | copyDone (void) |
| static SoFieldContainer * | findCopy (const SoFieldContainer *orig, const SbBool copyconnections) |
| static SoType | getClassTypeId (void) |
| This static method returns the SoType object associated with objects of this class. | |
| static void | initClass (void) |
| Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
| static void | initCopyDict (void) |
| Static Public Member Functions inherited from SoBase | |
| static void | addName (SoBase *const base, const char *const name) |
| static SbBool | connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) |
| static void | decrementCurrentWriteCounter (void) |
| static SoType | getClassTypeId (void) |
| This static method returns the SoType object associated with objects of this class. | |
| static SoBase * | getNamedBase (const SbName &name, SoType type) |
| static int | getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) |
| static SbBool | getTraceRefs (void) |
| static void | incrementCurrentWriteCounter (void) |
| static void | initClass (void) |
| Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
| static SbBool | read (SoInput *input, SoBase *&base, SoType expectedtype) |
| static SbBool | readRoute (SoInput *input) |
| static void | removeName (SoBase *const base, const char *const name) |
| static void | setInstancePrefix (const SbString &c) |
| static void | setTraceRefs (SbBool trace) |
Public Attributes | |
| SoSFBool | beginCap |
| SoSFBool | ccw |
| SoSFBool | convex |
| SoSFFloat | creaseAngle |
| SoMFVec2f | crossSection |
| SoSFBool | endCap |
| SoMFRotation | orientation |
| SoMFVec2f | scale |
| SoSFBool | solid |
| SoMFVec3f | spine |
Static Protected Member Functions | |
| static const SoFieldData ** | getFieldDataPtr (void) |
| Static Protected Member Functions inherited from SoVRMLGeometry | |
| static const SoFieldData ** | getFieldDataPtr (void) |
| Static Protected Member Functions inherited from SoShape | |
| static const SoFieldData ** | getFieldDataPtr (void) |
| Static Protected Member Functions inherited from SoNode | |
| static const SoFieldData ** | getFieldDataPtr (void) |
| static int | getNextActionMethodIndex (void) |
| static void | incNextActionMethodIndex (void) |
| static void | setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) |
| static void | setNextActionMethodIndex (int index) |
| Static Protected Member Functions inherited from SoBase | |
| static uint32_t | getCurrentWriteCounter (void) |
| static void | staticDataLock (void) |
| static void | staticDataUnlock (void) |
Additional Inherited Members | |
| Public Types inherited from SoShape | |
| enum | TriangleShape { TRIANGLE_STRIP , TRIANGLE_FAN , TRIANGLES , POLYGON , QUADS , QUAD_STRIP , POINTS , LINES , LINE_STRIP } |
| Public Types inherited from SoNode | |
| enum | NodeType { INVENTOR = 0x0000 , VRML1 = 0x0001 , VRML2 = 0x0002 , INVENTOR_1 = 0x0004 , INVENTOR_2_0 = 0x0008 , INVENTOR_2_1 = 0x0010 , INVENTOR_2_5 = 0x0020 , INVENTOR_2_6 = 0x0040 , COIN_1_0 = 0x0080 , COIN_2_0 = 0x0100 , EXTENSION = 0x0200 , COIN_2_2 = 0x0400 , COIN_2_3 = 0x0800 , COIN_2_4 = 0x1000 , INVENTOR_5_0 = 0x2000 , COIN_2_5 = 0x4000 , COIN_3_0 = 0x8000 , INVENTOR_6_0 = 0x10000 , COIN_4_0 = 0x20000 } |
| Protected Types inherited from SoBase | |
| enum | BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 } |
| Protected Attributes inherited from SoNode | |
| SbUniqueId | uniqueId |
| Protected Attributes inherited from SoFieldContainer | |
| SbBool | isBuiltIn |
| Static Protected Attributes inherited from SoNode | |
| static int | nextActionMethodIndex = 0 |
| static SbUniqueId | nextUniqueId = 1 |
The SoVRMLExtrusion class is a a geometry node for extruding a cross section along a spine.
The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:
Extrusion {
eventIn MFVec2f set_crossSection
eventIn MFRotation set_orientation
eventIn MFVec2f set_scale
eventIn MFVec3f set_spine
field SFBool beginCap TRUE
field SFBool ccw TRUE
field SFBool convex TRUE
field SFFloat creaseAngle 0 # [0,inf)
field MFVec2f crossSection [ 1 1, 1 -1, -1 -1, -1 1, 1 1 ] # (-inf,inf)
field SFBool endCap TRUE
field MFRotation orientation 0 0 1 0 # [-1,1],(-inf,inf)
field MFVec2f scale 1 1 # (0,inf)
field SFBool solid TRUE
field MFVec3f spine [ 0 0 0, 0 1 0 ] # (-inf,inf)
}
Introduction
The Extrusion node specifies geometric shapes based on a two dimensional cross-section extruded along a three dimensional spine in the local coordinate system. The cross-section can be scaled and rotated at each spine point to produce a wide variety of shapes. An Extrusion node is defined by:
Algorithmic description
Shapes are constructed as follows. The cross-section curve, which starts as a curve in the Y=0 plane, is first scaled about the origin by the first scale parameter (first value scales in X, second value scales in Z). It is then translated by the first spine point and oriented using the first orientation parameter (as explained later). The same procedure is followed to place a cross- section at the second spine point, using the second scale and orientation values. Corresponding vertices of the first and second cross-sections are then connected, forming a quadrilateral polygon between each pair of vertices. This same procedure is then repeated for the rest of the spine points, resulting in a surface extrusion along the spine.
The final orientation of each cross-section is computed by first orienting it relative to the spine segments on either side of point at which the cross-section is placed. This is known as the spine-aligned cross-section plane (SCP), and is designed to provide a smooth transition from one spine segment to the next (see Figure 6.6). The SCP is then rotated by the corresponding orientation value. This rotation is performed relative to the SCP. For example, to impart twist in the cross- section, a rotation about the Y-axis (0 1 0) would be used. Other orientations are valid and rotate the cross-section out of the SCP.
Figure 6.6 The SCP is computed by first computing its Y-axis and Z-axis, then taking the cross product of these to determine the X-axis. These three axes are then used to determine the rotation value needed to rotate the Y=0 plane to the SCP. This results in a plane that is the approximate tangent of the spine at each point, as shown in Figure 6.6. First the Y-axis is determined, as follows:
Let n be the number of spines and let i be the index variable satisfying 0 <= i < n:
The Z-axis is determined as follows:
Z = (spine[i+1] - spine[i]) × (spine[i-1] - spine[i])
Z = (spine[1] - spine[0]) × (spine[n-2] - spine[0])
Once the Y- and Z-axes have been computed, the X-axis can be calculated as their cross-product.
Special Cases
If the number of scale or orientation values is greater than the number of spine points, the excess values are ignored. If they contain one value, it is applied at all spine points. The results are undefined if the number of scale or orientation values is greater than one but less than the number of spine points. The scale values shall be positive.
If the three points used in computing the Z-axis are collinear, the cross-product is zero so the value from the previous point is used instead. If the Z-axis of the first point is undefined (because the spine is not closed and the first two spine segments are collinear) then the Z-axis for the first spine point with a defined Z-axis is used.
If the entire spine is collinear, the SCP is computed by finding the rotation of a vector along the positive Y-axis (v1) to the vector formed by the spine points (v2). The Y=0 plane is then rotated by this value. If two points are coincident, they both have the same SCP. If each point has a different orientation value, then the surface is constructed by connecting edges of the cross-sections as normal. This is useful in creating revolved surfaces.
Note: combining coincident and non-coincident spine segments, as well as other combinations, can lead to interpenetrating surfaces which the extrusion algorithm makes no attempt to avoid.
Common Cases
The following common cases are among the effects which are supported by the Extrusion node:
Other Fields
Extrusion has three parts: the sides, the beginCap (the surface at the initial end of the spine) and the endCap (the surface at the final end of the spine). The caps have an associated SFBool field that indicates whether each exists (TRUE) or doesn't exist (FALSE).
When the beginCap or endCap fields are specified as TRUE, planar cap surfaces will be generated regardless of whether the crossSection is a closed curve. If crossSection is not a closed curve, the caps are generated by adding a final point to crossSection that is equal to the initial point. An open surface can still have a cap, resulting (for a simple case) in a shape analogous to a soda can sliced in half vertically. These surfaces are generated even if spine is also a closed curve. If a field value is FALSE, the corresponding cap is not generated.
Texture coordinates are automatically generated by Extrusion nodes. Textures are mapped so that the coordinates range in the U direction from 0 to 1 along the crossSection curve (with 0 corresponding to the first point in crossSection and 1 to the last) and in the V direction from 0 to 1 along the spine curve (with 0 corresponding to the first listed spine point and 1 to the last). If either the endCap or beginCap exists, the crossSection curve is uniformly scaled and translated so that the larger dimension of the cross-section (X or Z) produces texture coordinates that range from 0.0 to 1.0. The beginCap and endCap textures' S and T directions correspond to the X and Z directions in which the crossSection coordinates are defined.
The browser shall automatically generate normals for the Extrusion node,using the creaseAngle field to determine if and how normals are smoothed across the surface. Normals for the caps are generated along the Y-axis of the SCP, with the ordering determined by viewing the cross-section from above (looking along the negative Y-axis of the SCP). By default, a beginCap with a counterclockwise ordering shall have a normal along the negative Y-axis. An endCap with a counterclockwise ordering shall have a normal along the positive Y-axis.
Each quadrilateral making up the sides of the extrusion are ordered from the bottom cross-section (the one at the earlier spine point) to the top. So, one quadrilateral has the points:
spine[0](crossSection[0], crossSection[1]) spine[1](crossSection[1], crossSection[0])
in that order. By default, normals for the sides are generated as described in 4.6.3, Shapes and geometry (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.3).
For instance, a circular crossSection with counterclockwise ordering and the default spine form a cylinder. With solid TRUE and ccw TRUE, the cylinder is visible from the outside. Changing ccw to FALSE makes it visible from the inside. The ccw, solid, convex, and creaseAngle fields are described in 4.6.3, Shapes and geometry (http://www.web3d.org/documents/specifications/14772/V2.0/part1/concepts.html#4.6.3).
| SoVRMLExtrusion::SoVRMLExtrusion | ( | void | ) |
Constructor.
|
protectedvirtual |
Destructor.
Implemented by SoShape subclasses to let the SoShape superclass know the exact size and weighted center point of the shape's bounding box.
The bounding box and center point should be calculated and returned in the local coordinate system.
The method implements action behavior for shape nodes for SoGetBoundingBoxAction. It is invoked from SoShape::getBoundingBox(). (Subclasses should not override SoNode::getBoundingBox().)
The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry.
Implements SoShape.
|
protectedvirtual |
Will create triangle detail for a SoPickedPoint. This method will only be called internally, when generatePrimitives() is used for picking (SoShape::rayPick() is not overridden).
This method returns NULL in Open Inventor, and subclasses will need to override this method to create details for a SoPickedPoint.
This is not necessary with Coin. Of course, if you choose to override it, it will work in the same way as Open Inventor.
For this to work, you must supply a face or line detail when generating primitives. If you supply NULL for the detail argument in SoShape::beginShape(), you'll have to override this method.
Reimplemented from SoShape.
The method implements action behavior for shape nodes for SoCallbackAction. It is invoked from SoShape::callback(). (Subclasses should not override SoNode::callback().)
The subclass implementations uses the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), with SoDetail instances, to pass the primitives making up the shape back to the caller.
Implements SoShape.
This static method returns the SoType object associated with objects of this class.
|
protectedvirtual |
Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.
Reimplemented from SoVRMLGeometry.
|
staticprotected |
This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.
Returns the SoFieldData class which holds information about fields in this node.
|
virtual |
Action method for the SoGetPrimitiveCountAction.
Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action.
Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.
Reimplemented from SoShape.
Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.
Reimplemented from SoVRMLGeometry.
|
virtual |
Action method for the SoGLRenderAction.
This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method.
Reimplemented from SoShape.
Notifies all auditors for this instance when changes are made.
Reimplemented from SoVRMLGeometry.
1.10.0