NodeMaterial Manual

Table of Contents

• About
• Access
• Use

About

A NodeMaterial represents a material containing node system. It can contain a separate node system for each available node space.

Access

A node material is accessed by checking if a given material uses nodes. Then the material can be cast into NodeMaterial.

• BaseList2D::IsNodeBased(): Returns true if the object contains nodes.

  // This example checks if the given material is node based and casts it into NodeMaterial.
 
  // get active material
  BaseMaterial* const material = doc->GetActiveMaterial();
  if (material == nullptr)
    return maxon::IllegalArgumentError(MAXON_SOURCE_LOCATION);
 
  // check if node based
  if (material->IsNodeBased() == false)
    return maxon::IllegalArgumentError(MAXON_SOURCE_LOCATION);
 
  // get node material
  NodeMaterial* const nodeMaterial = static_cast<NodeMaterial*>(material);

Use

A node material can contain multiple node system; one system for each node space.

• NodeMaterial::HasSpace(): Returns true if the node space with the given ID was instantiated for the material.
• NodeMaterial::GetGraph(): Returns the node graph for the given node space ID.

  // This example obtains the NodesGraphModelRef from the given NodeMaterial.
 
  // access node space
 
  const maxon::Id nodeSpaceID = GetActiveNodeSpaceId();
 
  if (nodeMaterial->HasSpace(nodeSpaceID) == false)
    return maxon::IllegalArgumentError(MAXON_SOURCE_LOCATION);
 
  const maxon::nodes::NodesGraphModelRef& graph = nodeMaterial->GetGraph(nodeSpaceID) iferr_return;

• NodeMaterial::GetMaterialNodePath(): Returns the node path to the material end node.
• NodeMaterial::GetSoloNodePath(): Returns the node path to the solo node.

  // This example gets the material end node of the given NodeMaterial and
  // stores all input ports of that node in an array.
 
  const maxon::Id nodeSpaceID = GetActiveNodeSpaceId();
 
  // get end node path
  maxon::NodePath path;
  nodeMaterial->GetMaterialNodePath(nodeSpaceID, path) iferr_return;
 
  if (path.IsEmpty())
    return maxon::OK;
 
  // get graph and node
  const maxon::nodes::NodesGraphModelRef& graph = nodeMaterial->GetGraph(nodeSpaceID) iferr_return;
  const maxon::GraphNode node = graph.GetNode(path);
 
  // get input ports
  const maxon::GraphNode inputPorts = node.GetPortList(maxon::PORT_DIR::INPUT) iferr_return;
 
  // store ports in base array
 
  maxon::BaseArray<maxon::GraphNode> ports;
  inputPorts.GetChildren(ports) iferr_return;

The node system does not store animation data. The animation data for a given node is stored in a BaseList2D object and its CTrack animation tracks.

• NodeMaterial::GetBaseListForNode(): Returns the corresponding BaseList2D element for the given maxon::NodePath.
• NodeMaterial::GetDescIDForNodePort(): Calculates the DescID for a given port.

  // This example accesses the BaseList2D object that stores the animation data for the given GraphNode.
 
  // get BaseList2D representation
  const BaseList2D* const baseList = nodeMaterial->GetBaseListForNode(nodeSpaceID, path) iferr_return;
  BaseList2D* const       listElementNonConst = const_cast<BaseList2D*>(baseList);
 
  // check all input ports
  for (const maxon::GraphNode& port : ports)
  {
    // get DescID
    DescID paramterID;
    nodeMaterial->GetDescIDForNodePort(nodeSpaceID, node, port, paramterID) iferr_return;
 
    const CTrack* const track = listElementNonConst->FindCTrack(paramterID);
    if (track != nullptr)
    {
      const maxon::String name = track->GetName();
      DiagnosticOutput("Track name: @", name);
    }
  }

Further functions are:

• NodeMaterial::GetTextureSearchPaths(): Gets the texture search paths.