Namespaces | Typedefs | Enumerations | Functions | Variables
maxon::neutron Namespace Reference

Namespaces

 NODESQUERY
 

Typedefs

using InstanceData = Tuple< BaseArray< Matrix >, BaseArray< Color64 >, BaseArray< Int32 >, BaseArray< UniqueHash > >
 
using ChangePluginTypeData = Tuple< Int32, NODEPLUGIN * >
 
using GetIconImageArgs = Tuple< GraphNode, Id, ImageRef >
 

Enumerations

enum class  OBJECT_FLAGS {
  NONE ,
  VIEWPORT_VISIBLE ,
  RENDER_VISIBLE ,
  DEFAULT ,
  VISIBLE_MASK
}
 
enum class  TRANSFORM_MODE {
  DISTRIBUTION ,
  CLONE ,
  CLONED_MESH ,
  MESH
}
 
enum class  INSTANCE_MATRIX_MODE {
  NONE ,
  LOCAL ,
  GLOBAL
}
 

Functions

 MAXON_DECLARATION (nodes::NodeSystemClass, NeutronNodeSystemClass, "net.maxon.neutron.nodesystemclass")
 
enum maxon::neutron::OBJECT_FLAGS MAXON_ENUM_FLAGS (OBJECT_FLAGS, "net.maxon.neutron.datatype.objectflags")
 
enum maxon::neutron::TRANSFORM_MODE MAXON_ENUM_LIST (TRANSFORM_MODE, "net.maxon.neutron.datatype.transformmode")
 
enum maxon::neutron::INSTANCE_MATRIX_MODE MAXON_ENUM_LIST (INSTANCE_MATRIX_MODE, "net.maxon.neutron.datatype.instancematrixmode")
 
Bool IsNeutronObjectType (Int32 type)
 
Bool IsNeutronType (Int32 type)
 

Variables

static constexpr Int32 SCENEHOOK_ID
 
static constexpr Int32 ID_NBO_SCENEEDITOR
 
static constexpr Int32 ID_NBO_FORCEDIRTY
 
static constexpr Int32 ID_NBO_CLEAR_DC_CACHE
 
static constexpr Int32 ID_NBO_CLEAR_DESC_CACHE
 
static constexpr Int32 ID_NBO_FORCE_DESC_DIRTY
 
static constexpr Int32 MATERIAL_PARAMETERS
 
static constexpr Int32 MSG_SET_INSTANCE_DATA
 
static constexpr Int32 MSG_ASK_SKIP_ONWRITE
 
static constexpr Int32 MSG_GET_XPRESSO_PORTS
 
static constexpr Int32 MSG_XPRESSO_DIRTY
 
static constexpr Int32 MSG_GET_NEUTRON_VIEWPORT_SCENE
 
static constexpr Int32 MSG_HAS_DATA
 
static constexpr Int32 MSG_UPDATE_LEGACY_OBJECTS
 
static constexpr Int32 MSG_GET_LEGACY_VIEWPORT_OBJECTS
 
static constexpr Int32 MSG_GET_SCENE
 
static constexpr Int32 MSG_GET_ICON_IMAGE
 
static constexpr Int32 MSG_GET_INSTRUMENTATION_HANDLER
 
static constexpr Int32 MSG_GET_ASSET_SERIALIZATION_DATA
 
static constexpr Int32 MSG_DESELECT_NODES
 
static constexpr Int32 MSG_GET_STORAGE_HELPER
 
static constexpr Int32 MSG_SETTINGS_NAME
 
static constexpr Int32 MSG_CHANGE_PLUGINTYPE
 
static constexpr Int32 MSG_REGISTER_THREADED_NIMBUS
 
static constexpr Int32 MSG_RESET_THREADED_NIMBUS
 
static constexpr Int32 MSG_CREATE_IF_REQUIRED
 
static constexpr Int32 MSG_ENABLE_ASSET_TO_GROUP
 
static constexpr Int32 MSG_IS_CAPSULE_EDITABLE
 
static constexpr Int32 MSG_IS_CAPSULE_GROUP
 
static constexpr Int32 MSG_SET_PICKING_RESULT
 
static constexpr Int32 NEUTRON_INSTANCE_NODE_PATH
 
static constexpr Int32 NEUTRON_INSTANCE_NODE_MODIFIER_PATH
 
static constexpr Int32 PERSISTENT_HASH_LOW
 
static constexpr Int32 LEGACY_CONVERSION_ID
 
static constexpr Int32 PERSISTENTHOOK_ID
 
static constexpr Int32 MSG_INSTRUMENTATION_MIN
 
static constexpr Int32 MSG_REGISTER_SCENE_LISTENER
 
static constexpr Int32 MSG_REGISTER_PORT_VALUE_LISTENER
 
static constexpr Int32 MSG_REGISTER_HEATMAP_LISTENER
 
static constexpr Int32 MSG_GET_INSPECTOR_PRESENTER
 
static constexpr Int32 MSG_INSTRUMENTATION_MAX
 
static constexpr Int32 TAG_ID
 
static constexpr Int32 MSG_TAG_SET_ASSET
 
static constexpr Int32 MSG_SET_ARCHIGRASS_ASSET
 
static constexpr Int32 MSG_SET_FROM_FILTERSTRING
 
static constexpr Int32 MSG_SET_ASSET_WITH_VERSION
 
static constexpr Int32 MSG_GET_ASSET_WITH_VERSION
 
static constexpr Int32 TAGSOFTYPE_NEUTRONGENERATEDPROXY
 
static constexpr Int32 NEUTRON_BASE_ID
 
static constexpr Int32 CAPSULE_BASE_ID
 
static constexpr Int32 DEFORMER_ID
 
static constexpr Int32 GENERATOR_ID
 
static constexpr Int32 DATASET_TO_TAG
 
static constexpr Int32 PRIMITIVE_GENERATOR_ID
 
static constexpr Int32 PRIMITIVE_SPLINE_GENERATOR_ID
 
static constexpr Int32 SCENE_PORT_LINK
 
static constexpr Int32 IDM_CAPSULE_ASSET_TO_GROUP
 
static constexpr Int32 IDM_HEATMAP_DUMP
 
static constexpr Int32 IDM_HEATMAP_ENABLE
 
static constexpr Int32 IDM_HEATMAP_ISENABLED
 
static constexpr Int32 IDM_HEATMAP_ISSUPPORTED
 
static constexpr Int32 IDM_HEATMAP_QUEUE_DUMP
 
static constexpr Int32 IDM_CAPSULE_DUMP
 
static constexpr Int32 IDM_CAPSULE_FORCEDIRTY
 
static constexpr Int32 MSG_NODESQUERY_MATERIAL
 
static constexpr Int32 MSG_NODESQUERY_MATERIAL_CHANNEL_ON
 
static constexpr Int32 MSG_NODESQUERY_MATERIAL_HASHCODE
 
static constexpr LiteralId NODESPACE
 
static constexpr LiteralId CAPSULEASSETWRAPPERID
 
static constexpr LiteralId SCENE_ROOT
 

Typedef Documentation

◆ InstanceData

using InstanceData = Tuple<BaseArray<Matrix>, BaseArray<Color64>, BaseArray<Int32>, BaseArray<UniqueHash> >

◆ ChangePluginTypeData

using ChangePluginTypeData = Tuple<Int32, NODEPLUGIN*>

◆ GetIconImageArgs

using GetIconImageArgs = Tuple<GraphNode, Id, ImageRef>

Enumeration Type Documentation

◆ OBJECT_FLAGS

enum OBJECT_FLAGS
strong
Enumerator
NONE 
VIEWPORT_VISIBLE 
RENDER_VISIBLE 
DEFAULT 
VISIBLE_MASK 

◆ TRANSFORM_MODE

enum TRANSFORM_MODE
strong
Enumerator
DISTRIBUTION 
CLONE 
CLONED_MESH 
MESH 

◆ INSTANCE_MATRIX_MODE

enum INSTANCE_MATRIX_MODE
strong
Enumerator
NONE 
LOCAL 
GLOBAL 

Function Documentation

◆ MAXON_DECLARATION()

maxon::neutron::MAXON_DECLARATION ( nodes::NodeSystemClass  ,
NeutronNodeSystemClass  ,
"net.maxon.neutron.nodesystemclass"   
)

This is the class of Neutron scene nodes.

◆ MAXON_ENUM_FLAGS()

enum maxon::neutron::OBJECT_FLAGS maxon::neutron::MAXON_ENUM_FLAGS ( OBJECT_FLAGS  ,
"net.maxon.neutron.datatype.objectflags"   
)

◆ MAXON_ENUM_LIST() [1/2]

enum maxon::neutron::TRANSFORM_MODE maxon::neutron::MAXON_ENUM_LIST ( TRANSFORM_MODE  ,
"net.maxon.neutron.datatype.transformmode"   
)

◆ MAXON_ENUM_LIST() [2/2]

enum maxon::neutron::INSTANCE_MATRIX_MODE maxon::neutron::MAXON_ENUM_LIST ( INSTANCE_MATRIX_MODE  ,
"net.maxon.neutron.datatype.instancematrixmode"   
)

◆ IsNeutronObjectType()

Bool maxon::neutron::IsNeutronObjectType ( Int32  type)

◆ IsNeutronType()

Bool maxon::neutron::IsNeutronType ( Int32  type)

Variable Documentation

◆ SCENEHOOK_ID

constexpr Int32 SCENEHOOK_ID
staticconstexpr

◆ ID_NBO_SCENEEDITOR

constexpr Int32 ID_NBO_SCENEEDITOR
staticconstexpr

◆ ID_NBO_FORCEDIRTY

constexpr Int32 ID_NBO_FORCEDIRTY
staticconstexpr

◆ ID_NBO_CLEAR_DC_CACHE

constexpr Int32 ID_NBO_CLEAR_DC_CACHE
staticconstexpr

◆ ID_NBO_CLEAR_DESC_CACHE

constexpr Int32 ID_NBO_CLEAR_DESC_CACHE
staticconstexpr

◆ ID_NBO_FORCE_DESC_DIRTY

constexpr Int32 ID_NBO_FORCE_DESC_DIRTY
staticconstexpr

◆ MATERIAL_PARAMETERS

constexpr Int32 MATERIAL_PARAMETERS
staticconstexpr

◆ MSG_SET_INSTANCE_DATA

constexpr Int32 MSG_SET_INSTANCE_DATA
staticconstexpr

◆ MSG_ASK_SKIP_ONWRITE

constexpr Int32 MSG_ASK_SKIP_ONWRITE
staticconstexpr

◆ MSG_GET_XPRESSO_PORTS

constexpr Int32 MSG_GET_XPRESSO_PORTS
staticconstexpr

◆ MSG_XPRESSO_DIRTY

constexpr Int32 MSG_XPRESSO_DIRTY
staticconstexpr

◆ MSG_GET_NEUTRON_VIEWPORT_SCENE

constexpr Int32 MSG_GET_NEUTRON_VIEWPORT_SCENE
staticconstexpr

◆ MSG_HAS_DATA

constexpr Int32 MSG_HAS_DATA
staticconstexpr

◆ MSG_UPDATE_LEGACY_OBJECTS

constexpr Int32 MSG_UPDATE_LEGACY_OBJECTS
staticconstexpr

◆ MSG_GET_LEGACY_VIEWPORT_OBJECTS

constexpr Int32 MSG_GET_LEGACY_VIEWPORT_OBJECTS
staticconstexpr

◆ MSG_GET_SCENE

constexpr Int32 MSG_GET_SCENE
staticconstexpr

◆ MSG_GET_ICON_IMAGE

constexpr Int32 MSG_GET_ICON_IMAGE
staticconstexpr

◆ MSG_GET_INSTRUMENTATION_HANDLER

constexpr Int32 MSG_GET_INSTRUMENTATION_HANDLER
staticconstexpr

◆ MSG_GET_ASSET_SERIALIZATION_DATA

constexpr Int32 MSG_GET_ASSET_SERIALIZATION_DATA
staticconstexpr

Gets the capsule's serializable node data. To yield a NodeSystemData that can be instantiated as a node or capsule, the resulting NodeSystemData will be created as if the capsule was a node. Hence, the SerializationNodeData will have a node asset as base id, not CAPSULEASSETWRAPPERID. Also the capsule related template arguments will be removed. Later capsule instantiation of this asset will instantiate CAPSULEASSETWRAPPERID NodeSystem with some capsule TemplatArguments to identify the asset used as a capsule. Arguments: Tuple<NodeSystemData /* Where to write the serializable data *‍/, Array<IdAndVersion> /* List of base assets ‍/>

◆ MSG_DESELECT_NODES

constexpr Int32 MSG_DESELECT_NODES
staticconstexpr

◆ MSG_GET_STORAGE_HELPER

constexpr Int32 MSG_GET_STORAGE_HELPER
staticconstexpr

◆ MSG_SETTINGS_NAME

constexpr Int32 MSG_SETTINGS_NAME
staticconstexpr

◆ MSG_CHANGE_PLUGINTYPE

constexpr Int32 MSG_CHANGE_PLUGINTYPE
staticconstexpr

◆ MSG_REGISTER_THREADED_NIMBUS

constexpr Int32 MSG_REGISTER_THREADED_NIMBUS
staticconstexpr

◆ MSG_RESET_THREADED_NIMBUS

constexpr Int32 MSG_RESET_THREADED_NIMBUS
staticconstexpr

◆ MSG_CREATE_IF_REQUIRED

constexpr Int32 MSG_CREATE_IF_REQUIRED
staticconstexpr

◆ MSG_ENABLE_ASSET_TO_GROUP

constexpr Int32 MSG_ENABLE_ASSET_TO_GROUP
staticconstexpr

◆ MSG_IS_CAPSULE_EDITABLE

constexpr Int32 MSG_IS_CAPSULE_EDITABLE
staticconstexpr

Message to ask a BaseList2D if it is an editable capsule. That can be true either for a capsule group or a capsule that can be made editable. Otherwise, false. Arguments: Bool*

◆ MSG_IS_CAPSULE_GROUP

constexpr Int32 MSG_IS_CAPSULE_GROUP
staticconstexpr

Message to ask a BaseList2D if it is a capsule group. Will return the group's identifier if the capsule is a group. Arguments: Id*

◆ MSG_SET_PICKING_RESULT

constexpr Int32 MSG_SET_PICKING_RESULT
staticconstexpr

◆ NEUTRON_INSTANCE_NODE_PATH

constexpr Int32 NEUTRON_INSTANCE_NODE_PATH
staticconstexpr

◆ NEUTRON_INSTANCE_NODE_MODIFIER_PATH

constexpr Int32 NEUTRON_INSTANCE_NODE_MODIFIER_PATH
staticconstexpr

◆ PERSISTENT_HASH_LOW

constexpr Int32 PERSISTENT_HASH_LOW
staticconstexpr

◆ LEGACY_CONVERSION_ID

constexpr Int32 LEGACY_CONVERSION_ID
staticconstexpr

◆ PERSISTENTHOOK_ID

constexpr Int32 PERSISTENTHOOK_ID
staticconstexpr

◆ MSG_INSTRUMENTATION_MIN

constexpr Int32 MSG_INSTRUMENTATION_MIN
staticconstexpr

◆ MSG_REGISTER_SCENE_LISTENER

constexpr Int32 MSG_REGISTER_SCENE_LISTENER
staticconstexpr

◆ MSG_REGISTER_PORT_VALUE_LISTENER

constexpr Int32 MSG_REGISTER_PORT_VALUE_LISTENER
staticconstexpr

◆ MSG_REGISTER_HEATMAP_LISTENER

constexpr Int32 MSG_REGISTER_HEATMAP_LISTENER
staticconstexpr

◆ MSG_GET_INSPECTOR_PRESENTER

constexpr Int32 MSG_GET_INSPECTOR_PRESENTER
staticconstexpr

◆ MSG_INSTRUMENTATION_MAX

constexpr Int32 MSG_INSTRUMENTATION_MAX
staticconstexpr

◆ TAG_ID

constexpr Int32 TAG_ID
staticconstexpr

◆ MSG_TAG_SET_ASSET

constexpr Int32 MSG_TAG_SET_ASSET
staticconstexpr

◆ MSG_SET_ARCHIGRASS_ASSET

constexpr Int32 MSG_SET_ARCHIGRASS_ASSET
staticconstexpr

◆ MSG_SET_FROM_FILTERSTRING

constexpr Int32 MSG_SET_FROM_FILTERSTRING
staticconstexpr

◆ MSG_SET_ASSET_WITH_VERSION

constexpr Int32 MSG_SET_ASSET_WITH_VERSION
staticconstexpr

Capsule instantiation message. Send it to a neutron::CAPSULE_BASE_ID type BaseList2D to have it become an instance of the given asset. Expects a pointer to an IdAndVersion of a node asset which can be found in the scope of the current document's repository. Arguments: const IdAndVersion*.

◆ MSG_GET_ASSET_WITH_VERSION

constexpr Int32 MSG_GET_ASSET_WITH_VERSION
staticconstexpr

Capsule instantiation message. Send it to a neutron::CAPSULE_BASE_ID type BaseList2D to get the identifier of the node asset from which this capsule originates. Argument: IdAndVersion* (output)

◆ TAGSOFTYPE_NEUTRONGENERATEDPROXY

constexpr Int32 TAGSOFTYPE_NEUTRONGENERATEDPROXY
staticconstexpr

◆ NEUTRON_BASE_ID

constexpr Int32 NEUTRON_BASE_ID
staticconstexpr

Base instance type for all the neutron related objects (scene hooks, tags, ...).

◆ CAPSULE_BASE_ID

constexpr Int32 CAPSULE_BASE_ID
staticconstexpr

Base instance type for all the capsules with types below.

◆ DEFORMER_ID

constexpr Int32 DEFORMER_ID
staticconstexpr

◆ GENERATOR_ID

constexpr Int32 GENERATOR_ID
staticconstexpr

◆ DATASET_TO_TAG

constexpr Int32 DATASET_TO_TAG
staticconstexpr

◆ PRIMITIVE_GENERATOR_ID

constexpr Int32 PRIMITIVE_GENERATOR_ID
staticconstexpr

◆ PRIMITIVE_SPLINE_GENERATOR_ID

constexpr Int32 PRIMITIVE_SPLINE_GENERATOR_ID
staticconstexpr

◆ SCENE_PORT_LINK

constexpr Int32 SCENE_PORT_LINK
staticconstexpr

◆ IDM_CAPSULE_ASSET_TO_GROUP

constexpr Int32 IDM_CAPSULE_ASSET_TO_GROUP
staticconstexpr

◆ IDM_HEATMAP_DUMP

constexpr Int32 IDM_HEATMAP_DUMP
staticconstexpr

No data. Will print heat map data from capsule/scene nodes to console.

◆ IDM_HEATMAP_ENABLE

constexpr Int32 IDM_HEATMAP_ENABLE
staticconstexpr

Expecting const Bool* data, true to enable heat map data collection on capsule/scene nodes.

◆ IDM_HEATMAP_ISENABLED

constexpr Int32 IDM_HEATMAP_ISENABLED
staticconstexpr

Expecting Bool* data, true if heat map is enabled for the capsule/scene nodes.

◆ IDM_HEATMAP_ISSUPPORTED

constexpr Int32 IDM_HEATMAP_ISSUPPORTED
staticconstexpr

Expecting Bool* data, true if heat map is supported by the object.

◆ IDM_HEATMAP_QUEUE_DUMP

constexpr Int32 IDM_HEATMAP_QUEUE_DUMP
staticconstexpr

No data. Will force a heat map update and print heat map to console afterwards.

◆ IDM_CAPSULE_DUMP

constexpr Int32 IDM_CAPSULE_DUMP
staticconstexpr

No data. Will print a capsule's node data to the console.

◆ IDM_CAPSULE_FORCEDIRTY

constexpr Int32 IDM_CAPSULE_FORCEDIRTY
staticconstexpr

No data. Will execute command ID_NBO_FORCEDIRTY for a capsule.

◆ MSG_NODESQUERY_MATERIAL

constexpr Int32 MSG_NODESQUERY_MATERIAL
staticconstexpr

◆ MSG_NODESQUERY_MATERIAL_CHANNEL_ON

constexpr Int32 MSG_NODESQUERY_MATERIAL_CHANNEL_ON
staticconstexpr

◆ MSG_NODESQUERY_MATERIAL_HASHCODE

constexpr Int32 MSG_NODESQUERY_MATERIAL_HASHCODE
staticconstexpr

◆ NODESPACE

constexpr LiteralId NODESPACE
staticconstexpr

Neutron node space identifier.

◆ CAPSULEASSETWRAPPERID

constexpr LiteralId CAPSULEASSETWRAPPERID
staticconstexpr

Identifier of the NodeTemplate used to wrap node assets in capsules. It's always the NodeSystem's first base in a capsule graph.

◆ SCENE_ROOT

constexpr LiteralId SCENE_ROOT
staticconstexpr