maxon.frameworks.graph¶

Note

Members documented here are defined in maxon.frameworks.graph module and are also exposed to the global maxon module. See the Maxon API section of the API Overview for more information about the special conventions of this API.

Description¶

Module for graph structures.

Interfaces¶

`GraphModelHelper`()	Regroups functions to simplify the usage of the node API.
`GraphAttributeInterface`(*args)	A graph attribute provides extra information about an attribute of nodes and ports.
`GraphMessageInterface`(*args)	A graph message is an error or warning message to tell the user about issues found in the graph.
`GraphModelInterface`(*args)	GraphModelInterface is an abstraction of a hierarchical graph.
`NodePathInterface`()	A `maxon.NodePath` identifies a graph node (a true node, port or port list) within a node graph.
`GraphLib`()	GraphLib contains some static functions for graphs.

References¶

`GraphAttribute`(*args)	Reference class for `maxon.GraphAttributeInterface`.
`GraphModelRef`(*args)	Reference class for `maxon.GraphModelInterface`.
`GraphMessage`(*args)	Reference class for `maxon.GraphMessageInterface`.

Data Types¶

`GraphNode`([src])	A `maxon.GraphNode` represents a general node (g-node for short) in the hierarchy of a `maxon.GraphModelInterface`.
`GraphTransaction`([src])	Modifications to a GraphModelInterface may only be done when there is an active GraphTransaction.
`NodePath`(*args)	Reference class for `maxon.NodePathInterface`.
`Wires`([value, event, dependency, context, …])	A port connection consists of up to eight independent wires:

Enums¶

`GraphModelInterface.GET_CONNECTIONS_MODE`()	Used with `GraphNode.GetConnections()` to control which connections shall be reported.
`GraphModelInterface.MODIFIED`()	These flags are reported by `GraphModelInterface.GetModificationsSince()` to tell which properties of the node have changed.
`GraphAttributeInterface.FLAGS`()	FLAGS provide information about the nature of the attribute.
`CONNECTION_POSITION`()	Graph connections can “store attribute values” `GraphNode.GetConnectionValue()` at three different positions:
`NODE_KIND`()	NODE_KIND allows to determine whether a general node (g-node for short) is a true node, a port or a port list.
`WIRE_MODE`()	WIRE_MODE is used for the wires in a Wires object to control whether a wire is set, inherited or hidden.

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.