Class SoClipPlaneElement


  • public class SoClipPlaneElement
    extends SoAccumulatedElement
    Stores the current set of clipping planes, specified as SbPlanes. This element stores the current set of clipping planes, specified as SbPlanes.

    When a plane is added, this element gets the current model matrix from the state and stores it in the instance. This allows the get() method to return the clip plane in object space (the plane as originally defined) or world space (after being transformed by the model matrix).

    See Also:
    SoClipPlane, SoOrthoSlice
    • Method Detail

      • get

        public SbPlane get​(int index)
        Calls get(index, true).
      • getMaxPlanes

        public static int getMaxPlanes()
        Returns the maximum number of concurrent clipping planes supported by current implementation.
      • getNum

        public int getNum()
        Returns the number of planes in an instance.
      • getInstance

        public static SoClipPlaneElement getInstance​(SoState state)
        Returns the top (current) instance of the element in the state.
      • getClassStackIndex

        @Deprecated
        public static int getClassStackIndex()
        Deprecated.
        As of Open Inventor 9300. replaced by SoElement.getClassStackIndex(Class)
        Returns the stack id for this element. ] *
      • get

        public SbPlane get​(int index,
                           boolean inWorldSpace)
        Returns the indexed plane an element as an SbPlane. The plane can be returned in object or world space.
      • add

        public static void add​(SoState state,
                               SoNode node,
                               SbPlane plane)
        Adds a clip plane to the current set in the state.