TextureTag Manual

Table of Contents

• About
• Allocation/Deallocation
• Properties
  • Material
  • Texture Matrix
• Further Reading

About

A TextureTag is used to assign a material (BaseMaterial) to a BaseObject. The class TextureTag is based on BaseTag so the typical workflows of handling tags apply, see BaseTag and VariableTag Manual.

TextureTag objects are an instance of Ttexture.

  // This example creates and configures a TextureTag.
 
  // create the texture tag
  TextureTag* const textureTag = static_cast<TextureTag*>(object->MakeTag(Ttexture));
  if (textureTag == nullptr)
    return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
 
  // apply material
  textureTag->SetMaterial(material);
 
  // check if there is a polygon selection tag on the given object
  // if a selection tag is found, restrict the material to that selection
  BaseTag* const polygonSelection = object->GetTag(Tpolygonselection);
  if (polygonSelection)
  {
    const String selectionName = polygonSelection->GetName();
    textureTag->SetParameter(DescID(TEXTURETAG_RESTRICTION), selectionName, DESCFLAGS_SET::NONE);
  }
 
  GeData data;
 
  // read "Texture" parameter
  material->GetParameter(DescID(MATERIAL_COLOR_SHADER), data, DESCFLAGS_GET::NONE);
 
  // if the material uses a bitmap shader, use UVW projection
  if (data.GetLink(doc, Xbitmap))
  {
    const DescID projectionParam { TEXTURETAG_PROJECTION };
    const Int32  projectionUVW = TEXTURETAG_PROJECTION_UVW;
    textureTag->SetParameter(projectionParam, projectionUVW, DESCFLAGS_SET::NONE);
  }

Allocation/Deallocation

TextureTag instances are created with the usual tools.

• TextureTag::Alloc(): Creates a new TextureTag.
• TextureTag::Free(): Destroys the given TextureTag.

  // This example creates a new texture tag and assigns it to the given BaseObject.
 
  BaseMaterial* const mat = doc->GetActiveMaterial();
  if (mat == nullptr)
    return maxon::IllegalArgumentError(MAXON_SOURCE_LOCATION);
 
  TextureTag* const textureTag = TextureTag::Alloc();
  if (textureTag == nullptr)
    return maxon::OutOfMemoryError(MAXON_SOURCE_LOCATION);
 
  textureTag->SetMaterial(mat);
 
  const DescID projectionParam { TEXTURETAG_PROJECTION };
  const Int32  projectionUVW = TEXTURETAG_PROJECTION_UVW;
  textureTag->SetParameter(projectionParam, projectionUVW, DESCFLAGS_SET::NONE);
 
  object->InsertTag(textureTag);

Properties

The parameters of a TextureTag can be edited with C4DAtom::SetParameter() and C4DAtom::GetParameter(). The parameter IDs of a TextureTag are defined in ttexture.h.

Material

A TextureTag stores a reference to a BaseMaterial based material.

• TextureTag::GetMaterial(): Returns the referenced material.
• TextureTag::SetMaterial(): Sets the referenced material.

  // This example accesses the texture tag on the given BaseObject.
  // The texture tag returns the linked material.
 
  TextureTag* const ttag = static_cast<TextureTag*>(object->GetTag(Ttexture));
  if (ttag == nullptr)
    return maxon::IllegalArgumentError(MAXON_SOURCE_LOCATION);
 
  BaseMaterial* const material = ttag->GetMaterial();
  if (material != nullptr)
  {
    ApplicationOutput("Used Material: " + material->GetName());
  }

Texture Matrix

A TextureTag also stores information on how the referenced material is applied to the host BaseObject. If the projection type is not UVW mapping the texture matrix is applied:

• TextureTag::GetPos(): Returns the position of the texture projection.
• TextureTag::SetPos(): Sets the position of the texture projection.
• TextureTag::GetScale(): Returns the scale of the texture projection.
• TextureTag::SetScale(): Sets the scale of the texture projection
• TextureTag::GetRot(): Returns the rotation of the texture projection.
• TextureTag::SetRot(): Sets the rotation of the texture projection.
• TextureTag::GetMl(): Returns the texture projection coordinate system as a matrix.
• TextureTag::SetMl(): Sets the texture projection's coordinate system matrix.

  // This example enables cubic projection and rotates the texture.
 
  const DescID projectionParam { TEXTURETAG_PROJECTION };
  const Int32  projectionCubic = TEXTURETAG_PROJECTION_CUBIC;
  textureTag->SetParameter(projectionParam, projectionCubic, DESCFLAGS_SET::NONE);
 
  const Float rotation = DegToRad(45.0);
  textureTag->SetRot(Vector { rotation, 0.0, 0.0 });

Further Reading

• Materials and Shaders Overview
• BaseMaterial Manual
• BaseObject Manual
• BaseTag and VariableTag Manual