SoVertexShape(3iv)

1SoVertexShape(3IV)()                                      SoVertexShape(3IV)()
2
3
4

NAME

6       SoVertexShape — abstract base class for all vertex-based shape nodes
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoNode > SoShape > SoVertexShape
10

SYNOPSIS

12       #include <Inventor/nodes/SoVertexShape.h>
13
14          Fields from class SoVertexShape:
15
16     SoSFNode            vertexProperty
17
18          Methods from class SoVertexShape:
19
20     static SoType       getClassTypeId()
21
22          Methods from class SoNode:
23
24     void                setOverride(SbBool state)
25     SbBool              isOverride() const
26     SoNode *            copy(SbBool copyConnections = FALSE) const
27     virtual SbBool      affectsState() const
28     static SoNode *     getByName(const SbName &name)
29     static int          getByName(const SbName &name, SoNodeList &list)
30
31          Methods from class SoFieldContainer:
32
33     void                setToDefaults()
34     SbBool              hasDefaultValues() const
35     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
36     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
37                              copyConnections = FALSE)
38     SbBool              set(const char *fieldDataString)
39     void                get(SbString &fieldDataString)
40     virtual int         getFields(SoFieldList &resultList) const
41     virtual SoField *   getField(const SbName &fieldName) const
42     SbBool              getFieldName(const SoField *field, SbName &fieldName)
43                              const
44     SbBool              isNotifyEnabled() const
45     SbBool              enableNotify(SbBool flag)
46
47          Methods from class SoBase:
48
49     void                ref()
50     void                unref() const
51     void                unrefNoDelete() const
52     void                touch()
53     virtual SoType      getTypeId() const
54     SbBool              isOfType(SoType type) const
55     virtual void        setName(const SbName &name)
56     virtual SbName      getName() const
57
58

DESCRIPTION

60       This node is the abstract base class for all vertex-based shape (geome‐
61       try) nodes. It is used as a repository for  convenience  functions  for
62       subclasses  and  to provide a type identifier to make it easy to deter‐
63       mine whether a shape is vertex-based. It contains one public field, the
64       SoVertexProperty field.
65
66       All  subclasses of this node draw objects constructed from vertices. If
67       the vertexProperty field is non-null and there are coordinates  in  the
68       associated  vertex property node, then those coordinates are used. Oth‐
69       erwise the objects are drawn  using  the  current  coordinates  in  the
70       state.  The  coordinates  of  the  shape are transformed by the current
71       transformation matrix and are drawn with the current  light  model  and
72       drawing style.
73
74       Subclasses that construct polygons from vertices may not render or pick
75       correctly if any of their polygons are self-intersecting or non-planar.
76
77       All vertex shape subclasses use the bounding box of the shape to deter‐
78       mine default texture coordinates. The longest dimension of the bounding
79       box defines the S coordinates, and the next longest defines the T coor‐
80       dinates. The value of the S coordinate ranges from 0 to 1, from one end
81       of the bounding box to the other. The T coordinate ranges between 0 and
82       the  ratio  of the second greatest dimension of the bounding box to the
83       greatest dimension.
84
85       When a vertex-based shape is picked with an SoRayPickAction,  a  detail
86       is  always returned. If the shape is composed of faces (such as SoFace‐
87       Set or SoTriangleStripSet), an SoFaceDetail is returned.  If the  shape
88       is  composed  of  line segments (such as SoLineSet), an SoLineDetail is
89       returned. If the shape is composed of points (such as  SoPointSet),  an
90       SoPointDetail is returned. Note that the type of detail returned is not
91       affected by the current drawing style.
92
93       Similarly, each class of vertex-based shape invokes  appropriate  call‐
94       backs  if  those  callbacks  are  registered with the SoCallbackAction.
95       Shapes made of faces invoke triangle callbacks for each generated  tri‐
96       angle.   (Faces  may be triangulated to create these triangles.) Shapes
97       made of line segments invoke line segment callbacks for  each  segment,
98       and shapes made of points invoke point callbacks.
99
100       The  subclass  SoIndexedShape  is  a base class for vertex-based shapes
101       that index into the current set of coordinates. The  subclass  SoNonIn‐
102       dexedShape is a base class for vertex-based shapes that use the current
103       coordinates in order.
104

FIELDS

106     SoSFNode            vertexProperty
107          vertex property node.
108
109

METHODS

111     static SoType       getClassTypeId()
112          Returns type identifier for this class.
113
114

FILE FORMAT/DEFAULTS

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