SoClipPlane(3iv)

1SoClipPlane(3IV)()                                          SoClipPlane(3IV)()
2
3
4

NAME

6       SoClipPlane — clipping plane node
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoNode > SoClipPlane
10

SYNOPSIS

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

DESCRIPTION

62       This  node  clips all subsequent shapes in the scene graph to the half-
63       space defined by the plane field. The half-space is  the  side  of  the
64       plane  in  the direction of the plane normal. For example, if the plane
65       is positioned at the origin and the normal is pointing down  the  posi‐
66       tive X axis, everything in the negative X space will be clipped away.
67
68       Any  number  of  clipping planes may be active simultaneously, although
69       the graphics library may place a limit on this number during rendering.
70

FIELDS

72     SoSFPlane           plane
73          Plane defining half-space.
74
75     SoSFBool            on
76          Whether clipping plane is active.
77
78

METHODS

80                         SoClipPlane()
81          Creates a clip plane node with default settings.
82
83     static SoType       getClassTypeId()
84          Returns type identifier for this class.
85
86

ACTION BEHAVIOR

88       SoGLRenderAction, SoCallbackAction, SoRayPickAction
89          Adds the plane to the current list of clipping planes in the state.
90
91

FILE FORMAT/DEFAULTS

93       ClipPlane {
94          plane  1 0 0  0
95          on     TRUE
96     }
97