SoBaseExtrusion Class Reference

Abstract base class for all extrusion-based shape nodes. More...

#include <Inventor/nodes/SoBaseExtrusion.h>

Inheritance diagram for SoBaseExtrusion:

Public Types
enum	ScaleMode {   DEFAULT ,   SPINE_ONLY ,   SECTION_ONLY ,   NONE }
enum	ExtrusionMode {   SMOOTH = 0 ,   BASIC = 1 ,   SMOOTH_WITHOUT_SELF_INTERSECTIONS = 2 }
Public Types inherited from SoShape
enum	ShapeType {   POINTS ,   LINES ,   POLYGONS ,   TEXT }
	Basic type for antialiased rendering for this shape (Do not consider the SoDrawStyle property currently in the state). More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
Public Member Functions inherited from SoShape
virtual SbBool	affectsState () const
	Overrides default method on SoNode.
ShapeType	getShapeType ()
	Gets the current shape Full Scene Antialiasing type.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	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.
SbBool	set (const SbString &fieldDataString)
	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.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoShape
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SbBool	isPrimitiveRestartAvailable (SoState *state=NULL)
	Returns TRUE if the primitive restart feature is available.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFBool	beginCap
	If TRUE, begin planar cap surfaces generated.
SoSFBool	endCap
	If TRUE, end planar cap surfaces generated.
SoMFVec3f	spine
	Spine points.
SoSFEnum	scaleMode
	Scaling behavior of the extrusion.
SoSFEnum	extrusionMode
	Construction behavior of the extrusion.
Public Attributes inherited from SoShape
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Friends
class	inventor::impl::SoExtrusionImpl

Detailed Description

Abstract base class for all extrusion-based shape nodes.

This node is the abstract base class for all extrusion-based shape (geometry) nodes. It is used as a repository for convenience functions for subclasses and to provide a type identifier to make it easy to determine whether a shape is extrusion-based.

All extrusion-based shapes are created by extruding a 2D shape along a 3D spine. The user can determine which caps are created using the fields beginCap and endCap.

The scaleMode field is used to select the points that will be scaled by the scaleFactor in the current transformation (for example SoTransform), if any. Translation and rotation are applied in all cases.

The extrusionMode field is used to select the extrusion algorithm.

FILE FORMAT/DEFAULT

This is an abstract class. See the reference page of a derived class for the format and default values.

SEE ALSO

SoExtrusion, SoCircularExtrusion

Definition at line 76 of file SoBaseExtrusion.h.

Member Enumeration Documentation

ExtrusionMode

enum SoBaseExtrusion::ExtrusionMode

Enumerator
SMOOTH	Default extrusion algorithm. The algorithm uses constant section parts cut at spine points in a way similar to what a framer would do to build a frame. This provides a better continuity of the shape and avoids cracks. This algorithm determines the piecewise extrusion directions as a vector between consecutive spine points. This means that zero or really small distances between consecutive points can produce odd extrusion directions and result in wrong geometry. It is up to the application to filter spine points to avoid these cases. The algorithm can produce odd geometries when spines points are overlapping or zigzags.
BASIC	Old extrusion algorithm. It does not guarantee that extrusion portions have constant section and shapes could be more twisted.
SMOOTH_WITHOUT_SELF_INTERSECTIONS	Smooth but avoids self intersections caused by large curvature radius of the spine. When the spine has curves with a large curvature radius compared to the radius of the extrusion section, SMOOTH generation might produce self intersections. Use this mode to avoid self intersections at the cost of some localized violation of the extrusion smoothness. (Section parts at spine joints may not be constant where self intersections were present.) This mode is useful to avoid artifacts in boolean results when SoBaseExtrusion derived objects are used as operands for CSG operations.

Definition at line 97 of file SoBaseExtrusion.h.

ScaleMode

enum SoBaseExtrusion::ScaleMode

Enumerator
DEFAULT	Default scaling. 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	Ignores the scaling state. Not currently implemented.

Definition at line 83 of file SoBaseExtrusion.h.

Member Function Documentation

getClassTypeId()

static SoType SoBaseExtrusion::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoBaseExtrusion::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoShape.

Reimplemented in SoCircularExtrusion, and SoExtrusion.

Friends And Related Symbol Documentation

inventor::impl::SoExtrusionImpl

friend class inventor::impl::SoExtrusionImpl

friend

Definition at line 193 of file SoBaseExtrusion.h.

Member Data Documentation

beginCap

SoSFBool SoBaseExtrusion::beginCap

If TRUE, begin planar cap surfaces generated.

Default is TRUE.

Definition at line 132 of file SoBaseExtrusion.h.

endCap

SoSFBool SoBaseExtrusion::endCap

If TRUE, end planar cap surfaces generated.

Default is TRUE.

Definition at line 137 of file SoBaseExtrusion.h.

extrusionMode

SoSFEnum SoBaseExtrusion::extrusionMode

Construction behavior of the extrusion.

Use enum ExtrusionMode. Default is SMOOTH.

Definition at line 154 of file SoBaseExtrusion.h.

scaleMode

SoSFEnum SoBaseExtrusion::scaleMode

Scaling behavior of the extrusion.

Use enum ScaleMode. Default is DEFAULT.

Definition at line 148 of file SoBaseExtrusion.h.

spine

SoMFVec3f SoBaseExtrusion::spine

Spine points.

Default is [0 0 0, 0 1 0].

Definition at line 142 of file SoBaseExtrusion.h.

---

The documentation for this class was generated from the following file:

• Inventor/nodes/SoBaseExtrusion.h