Coin Logo http://www.sim.no
http://www.coin3d.org

Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Friends

SoSeparatorKit Class Reference

The SoSeparatorKit class provides a typical set of nodes to influence a shape subgraph.Node kit structure (new entries versus parent class marked with arrow prefix): More...

#include <Inventor/nodekits/SoSeparatorKit.h>

Inheritance diagram for SoSeparatorKit:
SoBaseKit SoNode SoFieldContainer SoBase SoShapeKit SoWrapperKit

List of all members.

Public Types

enum  CacheEnabled { OFF, ON, AUTO }

Public Member Functions

 SoSeparatorKit (void)

Static Public Member Functions

static void initClass (void)

Public Attributes

SoSFEnum renderCaching
SoSFEnum boundingBoxCaching
SoSFEnum renderCulling
SoSFEnum pickCulling

Protected Member Functions

virtual ~SoSeparatorKit ()
virtual void setDefaultOnNonWritingFields (void)
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)

Friends

class SoSeparatorKitP

Detailed Description

The SoSeparatorKit class provides a typical set of nodes to influence a shape subgraph.

Node kit structure (new entries versus parent class marked with arrow prefix):

  CLASS SoSeparatorKit
  -->"this"
        "callbackList"
  -->   "topSeparator"
  -->      "pickStyle"
  -->      "appearance"
  -->      "units"
  -->      "transform"
  -->      "texture2Transform"
  -->      "childList"
  

(See SoBaseKit::printDiagram() for information about the output formatting.)

Detailed information on catalog parts:

  CLASS SoSeparatorKit
  PVT   "this",  SoSeparatorKit  --- 
        "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ] 
  PVT   "topSeparator",  SoSeparator  --- 
        "pickStyle",  SoPickStyle  --- 
        "appearance",  SoAppearanceKit  --- 
        "units",  SoUnits  --- 
        "transform",  SoTransform  --- 
        "texture2Transform",  SoTexture2Transform  --- 
        "childList",  SoNodeKitListPart [ SoShapeKit, SoSeparatorKit ] 
  

(See SoBaseKit::printTable() for information about the output formatting.)


Member Enumeration Documentation

Contains the same values with the same semantics as in the enum with the same name in SoSeparator. See documentation of SoSeparator::CacheEnabled.


Constructor & Destructor Documentation

SoSeparatorKit::SoSeparatorKit ( void  )
SoSeparatorKit::~SoSeparatorKit ( ) [protected, virtual]

Destructor.


Member Function Documentation

void SoSeparatorKit::initClass ( void  ) [static]

Does initialization common for all objects of the SoSeparatorKit class. This includes setting up the type system, among other things.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit, and SoWrapperKit.

Referenced by SoNodeKit::init().

void SoSeparatorKit::setDefaultOnNonWritingFields ( void  ) [protected, virtual]

(Be aware that this method is unlikely to be of interest to the application programmer who does not want to extend the library with new custom nodekits or draggers. If you indeed are writing extensions, see the information in the SoBaseKit class documentation.)

This is a virtual method, and the code in it should call SoField::setDefault() with argument TRUE on part fields that should not be written upon scenegraph export operations.

This is typically done when:

  1. field value is NULL and part is NULL by default

  2. it is a leaf SoGroup or SoSeparator node with no children

  3. it is a leaf listpart with no children and an SoGroup or SoSeparator container

  4. it is a non-leaf part and it's of SoGroup type and all fields are at their default values

Subclasses should usually override this to do additional settings for new member fields. From the subclass, do remember to call "upwards" to your superclass' setDefaultOnNonWritingFields() method.

Reimplemented from SoBaseKit.

Reimplemented in SoShapeKit.

References SoBaseKit::setDefaultOnNonWritingFields().

SbBool SoSeparatorKit::setUpConnections ( SbBool  onoff,
SbBool  doitalways = FALSE 
) [protected, virtual]

Sets up all internal connections for instances of this class.

(This method will usually not be of interest to the application programmer, unless you want to extend the library with new custom nodekits or dragger classes. If so, see the SoBaseKit class documentation.)

Reimplemented from SoBaseKit.

References SoBaseKit::connectionsSetUp, and SoBaseKit::setUpConnections().

Referenced by SoSeparatorKit().


Member Data Documentation

See documentation for SoSeparator::renderCaching.

Referenced by SoSeparatorKit().

See documentation for SoSeparator::boundingBoxCaching.

Referenced by SoSeparatorKit().

See documentation for SoSeparator::renderCulling.

Referenced by SoSeparatorKit().

See documentation for SoSeparator::pickCulling.

Referenced by SoSeparatorKit().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:19 for Coin by Doxygen. 1.7.3