Maxon API¶

Note

This page is part of the Maxon API. See the Maxon API section of the API Overview for more information about the special conventions of this API.

Frameworks¶

Name	Description
maxon.frameworks.animation	Module for Weight Manager algorithms.
maxon.frameworks.asset	Module for interacting with assets.
maxon.frameworks.cinema_hybrid	Module for interoperability between the Cinema and Maxon APIs.
maxon	Module for fundamental Maxon API types and operations.
maxon.frameworks.graph	Module for graph structures.
maxon.frameworks.mesh_misc	Module for mesh attributes.
maxon.frameworks.misc	Module for miscellaneous utilities.
maxon.frameworks.nodes	Module for node systems.
maxon.frameworks.nodespace	Module for node spaces.
maxon.frameworks.render_filter	Module for render filters.
maxon.frameworks.volume	Module for OpenVDB data.

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.

At least one option in each filter group must be selected. Use Ctrl+Shift+F (Cmd+Shift+F on macOS) to open search from any page; Enter opens the full search page and Escape closes the overlay.

Search results