Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoCone Class Reference

Cone shape node. More...

#include <Inventor/nodes/SoCone.h>

+ Inheritance diagram for SoCone:

Public Types

enum  Part {
  SIDES = 0x01 ,
  BOTTOM = 0x02 ,
  ALL = 0x03
}
 Cone parts. 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...
 

Public Member Functions

virtual SoType getTypeId () const
 Returns the type identifier for this specific instance.
 
 SoCone ()
 Creates a cone node with default settings.
 
void addPart (SoCone::Part part)
 Convenience function to turn on a part of the cone.
 
void removePart (SoCone::Part part)
 Convenience function to turn off a part of the cone.
 
SbBool hasPart (SoCone::Part part) const
 Convenience function that returns whether a given part is on or off.
 
- 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 SoNodecopy (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 SoFieldgetField (const SbName &fieldName) const
 Returns a the field of this object whose name is fieldName.
 
virtual SoFieldgetEventIn (const SbName &fieldName) const
 Returns a the eventIn with the given name.
 
virtual SoFieldgetEventOut (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 SoNodegetByName (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

SoSFBitMask parts
 Visible parts of cone.
 
SoSFFloat bottomRadius
 Specifies the radius of the base circle.
 
SoSFFloat height
 Specifies the cone's height.
 
- Public Attributes inherited from SoShape
SoSFBool boundingBoxIgnoring
 Whether to ignore this node during bounding box traversal.
 

Detailed Description

Cone shape node.

This node represents a simple cone whose central axis is aligned with the y-axis. By default, the cone is centered at (0,0,0) and has a size of -1 to +1 in all three directions. The cone has a radius of 1 at the bottom and a height of 2, with its apex at 1. The cone has two parts: the sides and the bottom.

The cone is transformed by the current cumulative transformation and is drawn with the current lighting model, drawing style, material, and geometric complexity.

If the current material binding is PER_PART or PER_PART_INDEXED, the first current material is used for the sides of the cone, and the second is used for the bottom. Otherwise, the first material is used for the entire cone.

When a texture is applied to a cone, it is applied differently to the sides and bottom. On the sides, the texture wraps counterclockwise (from above) starting at the back of the cone. The texture has a vertical seam at the back, intersecting the yz-plane. For the bottom, a circle is cut out of the texture square and applied to the cone's base circle. The texture appears right side up when the top of the cone is tilted away from the camera.

Picking: SoPickedPoint getDetail() returns an SoConeDetail.

OpenGL vertex arrays are used if they are available and if the environment variable IV_NO_VERTEX_ARRAY is not set.

Consider using the SoAlgebraicCone node instead of this one. Algebraic shapes are computed and rendered on the GPU and can be used with SoMultipleInstance.

FILE FORMAT/DEFAULT

    Cone {
    parts ALL
    bottomRadius 1
    height 2
    }

ACTION BEHAVIOR

    SoGLRenderAction
    Draws cone based on the current coordinates, materials, drawing style, and so on.

    SoRayPickAction
    Intersects the ray with the cone. The part of the cone that was picked is available from the SoConeDetail.

    SoGetBoundingBoxAction
    Computes the bounding box that encloses the cone.

    SoCallbackAction
    If any triangle callbacks are registered with the action, they will be invoked for each successive triangle that approximates the cone.

SEE ALSO

SoAlgebraicCone, SoConeDetail, SoCube, SoCylinder, SoFullSceneAntialiasing, SoSphere

Definition at line 143 of file SoCone.h.

Member Enumeration Documentation

◆ Part

Cone parts.

Enumerator
SIDES 

The conical part.

BOTTOM 

The bottom circular face.

ALL 

All parts.

Definition at line 151 of file SoCone.h.

Constructor & Destructor Documentation

◆ SoCone()

SoCone::SoCone ( )

Creates a cone node with default settings.

Member Function Documentation

◆ addPart()

void SoCone::addPart ( SoCone::Part  part)

Convenience function to turn on a part of the cone.

◆ getClassTypeId()

static SoType SoCone::getClassTypeId ( )
static

Returns the type identifier for this class.


◆ getTypeId()

virtual SoType SoCone::getTypeId ( ) const
virtual

Returns the type identifier for this specific instance.

Reimplemented from SoShape.

◆ hasPart()

SbBool SoCone::hasPart ( SoCone::Part  part) const

Convenience function that returns whether a given part is on or off.

◆ removePart()

void SoCone::removePart ( SoCone::Part  part)

Convenience function to turn off a part of the cone.

Member Data Documentation

◆ bottomRadius

SoSFFloat SoCone::bottomRadius

Specifies the radius of the base circle.

Value must be greater than 0.0.

Definition at line 174 of file SoCone.h.

◆ height

SoSFFloat SoCone::height

Specifies the cone's height.

Value must be greater than 0.0.

Definition at line 178 of file SoCone.h.

◆ parts

SoSFBitMask SoCone::parts

Visible parts of cone.

Definition at line 170 of file SoCone.h.


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