|
Open Inventor Release 2024.2.1
|
|
| |
|
Open Inventor Release 2024.2.1
|
|
|
| |
Algebraic cylinder shape node
More...
#include <Inventor/nodes/SoAlgebraicCylinder.h>
Inheritance diagram for SoAlgebraicCylinder:Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| SoAlgebraicCylinder () | |
| Default constructor. | |
| 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 SoAlgebraicShape | |
| 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 | |
| SoSFFloat | height |
| Specifies the cylinder's height. | |
| SoSFFloat | radius |
| Specifies the cylinder's radius. | |
| SoSFBool | capped |
| Specifies if cylinder is capped or not. | |
| Public Attributes inherited from SoAlgebraicShape | |
| SoSFNode | rayIntersection |
| Field for an SoFragmentShader object that defines the GLSL ray intersection function. | |
| SoSFEnum | workspace |
| Field to define the workspace. | |
| SoMFNode | shaderSlots |
| Multi-field for Shader slots of type SoShaderObject. | |
| SoSFBool | generateTransparency |
| Specify if the shape generates transparent fragment. | |
| SoSFEnum | clippingPolicy |
| Specifies how the algebraic shape should be clipped by a clipping plane. | |
| Public Attributes inherited from SoShape | |
| SoSFBool | boundingBoxIgnoring |
| Whether to ignore this node during bounding box traversal. | |
Additional Inherited Members | |
| Public Types inherited from SoAlgebraicShape | |
| enum | ASWorkSpace { BOX , CAMERA , WORLD , MAX_WORK_SPACE } |
| Specifies which reference frame to use inside the ray intersection shader function. More... | |
| enum | ASShaderSlot { COMPUTE_COLOR , VERTEX_SHADER_ENTRY , MAX_SHADER_SLOT } |
| Specifies the available slots for shader programs. More... | |
| enum | ASClippingPolicy { STANDARD , FULL_SHAPE } |
| Specifies how the algebraic shape should be clipped by a clipping plane. More... | |
| 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... | |
Algebraic cylinder shape node
This node represents a simple capped cylinder centered around the y-axis. By default, the cylinder is centered at (0,0,0) and has a default size of -1 to +1 in all three dimensions. You can use the radius and height fields to create a cylinder with a different size.
The cylinder is transformed by the current cumulative transformation and is drawn with the current lighting model and material.
This node can generally be used in place of the SoCylinder geometric shape node. Unlike the geometric shape nodes, which create triangle geometry to represent their shape, the algebraic shape nodes compute and render their shape on the GPU. Algebraic shapes can also be used with SoMultipleInstance to efficiently render a very large number of shapes.
Please see SoAlgebraicShape for important notes and limitations for algebraic shapes.
| radius | 1 |
| height | 2 |
| capping | TRUE |
SoAlgebraicShape, SoMultipleInstance, SoCylinder
Definition at line 44 of file SoAlgebraicCylinder.h.
| SoAlgebraicCylinder::SoAlgebraicCylinder | ( | ) |
Default constructor.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoAlgebraicShape.
| SoSFBool SoAlgebraicCylinder::capped |
Specifies if cylinder is capped or not.
Default is true.
Definition at line 63 of file SoAlgebraicCylinder.h.
| SoSFFloat SoAlgebraicCylinder::height |
Specifies the cylinder's height.
Value must be greater than 0.0. Default is 2.
Definition at line 53 of file SoAlgebraicCylinder.h.
| SoSFFloat SoAlgebraicCylinder::radius |
Specifies the cylinder's radius.
Value must be greater than 0.0. Default is 1.
Definition at line 58 of file SoAlgebraicCylinder.h.
1.9.8 