SBFolder

SBFolder#

This class describes a document folder. A document folder may contain various types of nodes: structural nodes, dynamical models, simulators, visual models, notes, labels, other folders, etc.

Apart from possibility to get nodes using samson.SBFolder.getNodes() or samson.SBFolder.getChildren() function, samson.SBFolder provides additional functionality to get a list of nodes with specific types. Let’s for example get a list of folders inside of a folder:

# get a list of all folders in the given folder
folderIndexer = folder.getFolderList()

# print names of subfolders
for f in folderIndexer:
    print(f)

Note that this function is not recursive.

You can clone a folder with all its descendants as any other data graph node:

# clone the folder
clonedFolder = folder.clone()

# turn the undo system on
with SAMSON.holding("Add new folder"):
        # hold the cloned folder instance
        SAMSON.hold(clonedFolder)
        # create the cloned folder
        clonedFolder.create()
        # add the cloned folder to the active document
        SAMSON.getActiveDocument().addChild(clonedFolder)

See also

SAMSON SDK: SBDDocumentFolder

class samson.SBFolder(*args, **kwargs)#

Bases: SBNode

This class describes a document folder.

Overloaded function.

__init__(self: samson.SBFolder) -> None

Constructs a folder.

__init__(self: samson.SBFolder, name: str) -> None

Constructs a folder with the given name.

Parameters:: name (str) – A name of the folder.

Examples

Add a folder to the active document and make this operation undoable.

>>> folder = SBFolder('New folder')
>>> with SAMSON.holding('Add folder'):
...             SAMSON.hold(folder)
...             folder.create()
...             SAMSON.getActiveDocument().addChild(folder)

getAnimationIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of animations in this folder.

getAssetIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of assets in this folder.

getCameraIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of cameras in this folder.

getChildren(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of children of the folder

getConformationIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of conformations in this folder.

getControllerIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of controllers in this folder.

getDynamicalModelIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of dynamical models in this folder.

getFileIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of files in this folder.

getFolderIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of folders in this folder.

getInteractionModelIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of interaction models in this folder.

getLabelIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of labels in this folder.

getModelIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of models in this folder.

getNextFolder(self: samson.SBFolder) → samson.SBFolder#: Returns the next folder.

getNodeGroupIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of node groups in this folder.

getNoteIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of notes in this folder.

getPathIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of paths in this folder.

getPresentationIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of presentations in this folder.

getPreviousFolder(self: samson.SBFolder) → samson.SBFolder#: Returns the previous folder.

getPropertyModelIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of property models in this folder.

getRenderPresetIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of render presets in this folder.

getSimulatorIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of simulators in this folder.

getStructuralModelIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of structural models in this folder.

getVisualModelIndexer(self: samson.SBFolder) → samson.SBNodeIndexer#: Returns an indexer of visual models in this folder.

initialize(self: samson.SBFolder) → bool#

Initializes the folder.

Notes

This is a virtual function that might be overridden in classes based on SBFolder.

SBFolder

Contents

SBFolder#