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

Public Member Functions | Static Public Member Functions
SoNodekitCatalog Class Reference

The SoNodekitCatalog class is a container for nodekit layouts.Nodekits store all their hierarchical layout information and part information in instances of this class. More...

#include <Inventor/nodekits/SoNodekitCatalog.h>

List of all members.

Public Member Functions

 SoNodekitCatalog (void)
 ~SoNodekitCatalog ()
int getNumEntries (void) const
int getPartNumber (const SbName &name) const
const SbNamegetName (int part) const
SoType getType (int part) const
SoType getType (const SbName &name) const
SoType getDefaultType (int part) const
SoType getDefaultType (const SbName &name) const
SbBool isNullByDefault (int part) const
SbBool isNullByDefault (const SbName &name) const
SbBool isLeaf (int part) const
SbBool isLeaf (const SbName &name) const
const SbNamegetParentName (int part) const
const SbNamegetParentName (const SbName &name) const
int getParentPartNumber (int part) const
int getParentPartNumber (const SbName &name) const
const SbNamegetRightSiblingName (int part) const
const SbNamegetRightSiblingName (const SbName &name) const
int getRightSiblingPartNumber (int part) const
int getRightSiblingPartNumber (const SbName &name) const
SbBool isList (int part) const
SbBool isList (const SbName &name) const
SoType getListContainerType (int part) const
SoType getListContainerType (const SbName &name) const
const SoTypeListgetListItemTypes (int part) const
const SoTypeListgetListItemTypes (const SbName &name) const
SbBool isPublic (int part) const
SbBool isPublic (const SbName &name) const
SoNodekitCatalogclone (SoType type) const
SbBool addEntry (const SbName &name, SoType type, SoType defaulttype, SbBool isdefaultnull, const SbName &parent, const SbName &rightsibling, SbBool islist, SoType listcontainertype, SoType listitemtype, SbBool ispublic)
void addListItemType (int part, SoType type)
void addListItemType (const SbName &name, SoType type)
void narrowTypes (const SbName &name, SoType newtype, SoType newdefaulttype)
void setNullByDefault (const SbName &name, SbBool nullbydefault)
SbBool recursiveSearch (int part, const SbName &name, SoTypeList *checked) const
void printCheck (void) const

Static Public Member Functions

static void initClass (void)

Detailed Description

The SoNodekitCatalog class is a container for nodekit layouts.

Nodekits store all their hierarchical layout information and part information in instances of this class.

See also:
SoNodeKit, SoBaseKit

Constructor & Destructor Documentation

SoNodekitCatalog::SoNodekitCatalog ( void  )

Constructor.

Referenced by clone().

SoNodekitCatalog::~SoNodekitCatalog ( )

Destructor.

References SbList::getLength().


Member Function Documentation

void SoNodekitCatalog::initClass ( void  ) [static]

Initialization of static variables.

int SoNodekitCatalog::getNumEntries ( void  ) const
int SoNodekitCatalog::getPartNumber ( const SbName name) const
const SbName & SoNodekitCatalog::getName ( int  part) const
SoType SoNodekitCatalog::getType ( int  part) const

Given the part number, return type.

References SbList::getLength(), and getNumEntries().

Referenced by SoBaseKit::printSubDiagram(), SoBaseKit::printTable(), getType(), and recursiveSearch().

SoType SoNodekitCatalog::getType ( const SbName name) const

Given the part name, return type.

References SbList::getLength(), getType(), and getPartNumber().

SoType SoNodekitCatalog::getDefaultType ( int  part) const

Given part number, return default type of part.

References SbList::getLength(), and getNumEntries().

Referenced by SoBaseKit::printTable(), and getDefaultType().

SoType SoNodekitCatalog::getDefaultType ( const SbName name) const

Given part name, return default type of part.

References SbList::getLength(), getDefaultType(), and getPartNumber().

SbBool SoNodekitCatalog::isNullByDefault ( int  part) const

Returns TRUE if the part is empty by default, otherwise FALSE.

References SbList::getLength().

Referenced by SoBaseKit::setDefaultOnNonWritingFields(), SoBaseKit::createDefaultParts(), and isNullByDefault().

SbBool SoNodekitCatalog::isNullByDefault ( const SbName name) const

Returns TRUE if part name is empty by default, otherwise FALSE.

References SbList::getLength(), isNullByDefault(), and getPartNumber().

SbBool SoNodekitCatalog::isLeaf ( int  part) const
SbBool SoNodekitCatalog::isLeaf ( const SbName name) const

Returns TRUE if the part name is not a parent for any other parts in the nodekit catalog.

References SbList::getLength(), isLeaf(), and getPartNumber().

const SbName & SoNodekitCatalog::getParentName ( int  part) const

Returns name of parent of part. If part doesn't have a parent, the empty string is returned.

References SbList::getLength(), and getNumEntries().

Referenced by SoBaseKit::printSubDiagram(), and getParentName().

const SbName & SoNodekitCatalog::getParentName ( const SbName name) const

Returns name of parent of the part. If name doesn't have a parent, the empty string is returned.

References SbList::getLength(), getParentName(), and getPartNumber().

int SoNodekitCatalog::getParentPartNumber ( int  part) const

Returns part number of given part's parent. If part doesn't have a parent, SO_CATALOG_NAME_NOT_FOUND is returned.

References SbList::getLength(), getNumEntries(), and getPartNumber().

Referenced by getParentPartNumber().

int SoNodekitCatalog::getParentPartNumber ( const SbName name) const

Returns part number of given part's parent. If name doesn't have a parent, SO_CATALOG_NAME_NOT_FOUND is returned.

References SbList::getLength(), getParentPartNumber(), and getPartNumber().

const SbName & SoNodekitCatalog::getRightSiblingName ( int  part) const

Returns name of right sibling of part. Returns the empty string if part doesn't have a right sibling.

References SbList::getLength(), and getNumEntries().

Referenced by getRightSiblingName().

const SbName & SoNodekitCatalog::getRightSiblingName ( const SbName name) const

Returns name of sibling of the part. Returns the empty string if name doesn't have a right sibling.

References SbList::getLength(), getRightSiblingName(), and getPartNumber().

int SoNodekitCatalog::getRightSiblingPartNumber ( int  part) const

Returns part number of given part's sibling. Returns SO_CATALOG_NAME_NOT_FOUND if part doesn't have a right sibling.

References SbList::getLength(), getNumEntries(), and getPartNumber().

Referenced by getRightSiblingPartNumber().

int SoNodekitCatalog::getRightSiblingPartNumber ( const SbName name) const

Returns part number of given part's right sibling. Returns SO_CATALOG_NAME_NOT_FOUND if part doesn't have a right sibling.

References SbList::getLength(), getRightSiblingPartNumber(), and getPartNumber().

SbBool SoNodekitCatalog::isList ( int  part) const

Returns TRUE if the given part is a list container.

References SbList::getLength(), and getNumEntries().

Referenced by SoBaseKit::printTable(), and isList().

SbBool SoNodekitCatalog::isList ( const SbName name) const

Returns TRUE if the given part is a list container.

References SbList::getLength(), isList(), and getPartNumber().

SoType SoNodekitCatalog::getListContainerType ( int  part) const

Returns type of list container (SoGroup, SoSeparator, SoSwitch, etc) which part is.

References SbList::getLength(), and getNumEntries().

Referenced by getListContainerType().

SoType SoNodekitCatalog::getListContainerType ( const SbName name) const

Returns type of list container (SoGroup, SoSeparator, SoSwitch, etc) which the named part is.

References SbList::getLength(), getListContainerType(), and getPartNumber().

const SoTypeList & SoNodekitCatalog::getListItemTypes ( int  part) const

Returns list of node types which are allowed to be children of the list container part.

References SbList::getLength(), and getNumEntries().

Referenced by SoBaseKit::printTable(), and getListItemTypes().

const SoTypeList & SoNodekitCatalog::getListItemTypes ( const SbName name) const

Returns list of node types which are allowed to be children of the named list container part.

References SbList::getLength(), getListItemTypes(), and getPartNumber().

SbBool SoNodekitCatalog::isPublic ( int  part) const

Returns TRUE if part is visible and publicly available for queries and modifications, FALSE if part is hidden.

References SbList::getLength(), and getNumEntries().

Referenced by SoBaseKit::printTable(), SoBaseKit::getAnyPart(), SoBaseKit::createPathToAnyPart(), SoBaseKit::setAnyPart(), and isPublic().

SbBool SoNodekitCatalog::isPublic ( const SbName name) const

Returns TRUE if the part is visible and publicly available for queries and modifications, FALSE if it is hidden.

References SbList::getLength(), isPublic(), and getPartNumber().

SoNodekitCatalog * SoNodekitCatalog::clone ( SoType  type) const

Return a clone of this catalog. type will be used to set the type and defaulttype values of the toplevel this entry.

References SbList::getLength(), and SoNodekitCatalog().

SbBool SoNodekitCatalog::addEntry ( const SbName name,
SoType  type,
SoType  defaulttype,
SbBool  isdefaultnull,
const SbName parentname,
const SbName rightsiblingname,
SbBool  islist,
SoType  listcontainertype,
SoType  listitemtype,
SbBool  ispublic 
)
void SoNodekitCatalog::addListItemType ( int  part,
SoType  type 
)

Add another allowable type for the given part. part must of course be a list container item.

References SbList::getLength().

Referenced by addListItemType().

void SoNodekitCatalog::addListItemType ( const SbName name,
SoType  type 
)

Add another allowable type for the name part. The part must of course be a list container.

References addListItemType(), SoDebugError::post(), and SbName::getString().

void SoNodekitCatalog::narrowTypes ( const SbName name,
SoType  newtype,
SoType  newdefaulttype 
)

Set the type and default type of a part to be subtypes of the old types. Useful for "narrowing" the specification of a nodekit which inherits the catalog of a more generic nodekit superclass.

References SbList::getLength(), getPartNumber(), and SoType::isDerivedFrom().

void SoNodekitCatalog::setNullByDefault ( const SbName name,
SbBool  nullbydefault 
)

Change whether or not the part with the given name is created by default.

References SbList::getLength(), and getPartNumber().

SbBool SoNodekitCatalog::recursiveSearch ( int  part,
const SbName name,
SoTypeList checked 
) const

Recursively search part number in catalog for the name part.

The checked SoTypeList is just used as a placeholder to remember which nodekit class catalogs have already been scanned (or are being scanned) during the recursion. You should normally just pass in an empty list.

References SbList::getLength(), getNumEntries(), SoTypeList::find(), SoTypeList::append(), getName(), getType(), SoType::isDerivedFrom(), SoNode::getClassTypeId(), SoType::createInstance(), SoBase::ref(), SoBaseKit::getNodekitCatalog(), recursiveSearch(), and SoBase::unref().

Referenced by recursiveSearch().

void SoNodekitCatalog::printCheck ( void  ) const

Lists all catalog parts, which is useful for debugging.

References getNumEntries(), and SoType::badType().


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

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

Generated on Wed Feb 8 2012 for Coin by Doxygen. 1.7.5