SoNodekitCatalog - Online Linux Manual PageSection : 3
Updated : Mon Jan 25 2021
Source : Version 4.0.0
Note : Coin

NAMESoNodekitCatalog − The SoNodekitCatalog class is a container for nodekit layouts​.

SYNOPSIS
#include <Inventor/nodekits/SoNodekitCatalog​.h>

Public Member FunctionsSoNodekitCatalog (void)
~SoNodekitCatalog ()
int getNumEntries (void) const
int getPartNumber (const SbName &name) const
const SbName & getName (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 SbName & getParentName (int part) const
const SbName & getParentName (const SbName &name) const
int getParentPartNumber (int part) const
int getParentPartNumber (const SbName &name) const
const SbName & getRightSiblingName (int part) const
const SbName & getRightSiblingName (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 SoTypeList & getListItemTypes (int part) const
const SoTypeList & getListItemTypes (const SbName &name) const
SbBool isPublic (int part) const
SbBool isPublic (const SbName &name) const
SoNodekitCatalog * clone (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 Functionsstatic void initClass (void)

Detailed DescriptionThe 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​.

SoNodekitCatalog::~SoNodekitCatalog ()Destructor​.

Member Function Documentation

void SoNodekitCatalog::initClass (void) [static]Initialization of static variables​.

int SoNodekitCatalog::getNumEntries (void) constReturns total number of entries in the catalog​.

int SoNodekitCatalog::getPartNumber (const SbName & name) constReturns part number in catalog with name​. If no part exists with name, returns SO_CATALOG_NAME_NOT_FOUND​.

const SbName & SoNodekitCatalog::getName (int part) constGiven the part number, return name of that part​.

SoType SoNodekitCatalog::getType (int part) constGiven the part number, return type​.

SoType SoNodekitCatalog::getType (const SbName & name) constGiven the part name, return type​.

SoType SoNodekitCatalog::getDefaultType (int part) constGiven part number, return default type of part​.

SoType SoNodekitCatalog::getDefaultType (const SbName & name) constGiven part name, return default type of part​.

SbBool SoNodekitCatalog::isNullByDefault (int part) constReturns TRUE if the part is empty by default, otherwise FALSE​.

SbBool SoNodekitCatalog::isNullByDefault (const SbName & name) constReturns TRUE if part name is empty by default, otherwise FALSE​.

SbBool SoNodekitCatalog::isLeaf (int part) constReturns TRUE if the part is not a parent for any other parts in the nodekit catalog​.

SbBool SoNodekitCatalog::isLeaf (const SbName & name) constReturns TRUE if the part name is not a parent for any other parts in the nodekit catalog​.

const SbName & SoNodekitCatalog::getParentName (int part) constReturns name of parent of part​. If part doesn't have a parent, the empty string is returned​.

const SbName & SoNodekitCatalog::getParentName (const SbName & name) constReturns name of parent of the part​. If name doesn't have a parent, the empty string is returned​.

int SoNodekitCatalog::getParentPartNumber (int part) constReturns part number of given part's parent​. If part doesn't have a parent, SO_CATALOG_NAME_NOT_FOUND is returned​.

int SoNodekitCatalog::getParentPartNumber (const SbName & name) constReturns part number of given part's parent​. If name doesn't have a parent, SO_CATALOG_NAME_NOT_FOUND is returned​.

const SbName & SoNodekitCatalog::getRightSiblingName (int part) constReturns name of right sibling of part​. Returns the empty string if part doesn't have a right sibling​.

const SbName & SoNodekitCatalog::getRightSiblingName (const SbName & name) constReturns name of sibling of the part​. Returns the empty string if name doesn't have a right sibling​.

int SoNodekitCatalog::getRightSiblingPartNumber (int part) constReturns part number of given part's sibling​. Returns SO_CATALOG_NAME_NOT_FOUND if part doesn't have a right sibling​.

int SoNodekitCatalog::getRightSiblingPartNumber (const SbName & name) constReturns part number of given part's right sibling​. Returns SO_CATALOG_NAME_NOT_FOUND if part doesn't have a right sibling​.

SbBool SoNodekitCatalog::isList (int part) constReturns TRUE if the given part is a list container​.

SbBool SoNodekitCatalog::isList (const SbName & name) constReturns TRUE if the given part is a list container​.

SoType SoNodekitCatalog::getListContainerType (int part) constReturns type of list container (SoGroup, SoSeparator, SoSwitch, etc) which part is​.

SoType SoNodekitCatalog::getListContainerType (const SbName & name) constReturns type of list container (SoGroup, SoSeparator, SoSwitch, etc) which the named part is​.

const SoTypeList & SoNodekitCatalog::getListItemTypes (int part) constReturns list of node types which are allowed to be children of the list container part​.

const SoTypeList & SoNodekitCatalog::getListItemTypes (const SbName & name) constReturns list of node types which are allowed to be children of the named list container part​.

SbBool SoNodekitCatalog::isPublic (int part) constReturns TRUE if part is visible and publicly available for queries and modifications, FALSE if part is hidden​.

SbBool SoNodekitCatalog::isPublic (const SbName & name) constReturns TRUE if the part is visible and publicly available for queries and modifications, FALSE if it is hidden​.

SoNodekitCatalog * SoNodekitCatalog::clone (SoType type) constReturn a clone of this catalog​. type will be used to set the type and defaulttype values of the toplevel this entry​.

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)Add a new entry to the catalog​. Returns TRUE if add was ok​.

void SoNodekitCatalog::addListItemType (int part, SoType type)Add another allowable type for the given part​. part must of course be a list container item​.

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​.

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​.

void SoNodekitCatalog::setNullByDefault (const SbName & name, SbBool nullbydefault)Change whether or not the part with the given name is created by default​.

SbBool SoNodekitCatalog::recursiveSearch (int part, const SbName & name, SoTypeList * checked) constRecursively 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​.

void SoNodekitCatalog::printCheck (void) constLists all catalog parts, which is useful for debugging​.

AuthorGenerated automatically by Doxygen for Coin from the source code​.
0
Johanes Gumabo
Data Size   :   45,135 byte
man-SoNodekitCatalog.3coin4Build   :   2024-12-05, 20:55   :  
Visitor Screen   :   x
Visitor Counter ( page / site )   :   3 / 189,458
Visitor ID   :     :  
Visitor IP   :   18.223.239.65   :  
Visitor Provider   :   AMAZON-02   :  
Provider Position ( lat x lon )   :   39.962500 x -83.006100   :   x
Provider Accuracy Radius ( km )   :   1000   :  
Provider City   :   Columbus   :  
Provider Province   :   Ohio ,   :   ,
Provider Country   :   United States   :  
Provider Continent   :   North America   :  
Visitor Recorder   :   Version   :  
Visitor Recorder   :   Library   :  
Online Linux Manual Page   :   Version   :   Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page   :   Library   :   lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page   :   Library   :   lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base   :   Version   :   Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base   :   Library   :   lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36

Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.