Here you will find documentation on all the descriptions that Cinema 4D currently has. You can list them Alphabetically, by Type or Plugin . The sample Python and C++ code is automatically generated and in some cases may not be 100% correct. If something doesn't work then please refer to the official Cinema 4D SDK documentation for more information.

IDs and information for vstag

vstag

Attributes

  • ENGLISH NAME : VisualSelectorTag
  • NAME : vstag
  • INCLUDE : Tbase
  • PATH : ca2/description/vstag.res
  • PLUGIN : ca2
  • MAXON online help (may not exist): VSTAG

Elements

ID UI Name Type Parameters Cycle
ID_VS_TAG_NAME Name STRING  
ID_VS_TAG_IMAGE ImageFile TEXTURE  
ID_VS_TAG_ASPECT AspectRatio LONG  
ID_VS_TAG_ASPECT_11 1/1
ID_VS_TAG_ASPECT_43 4/3
ID_VS_TAG_ASPECT_34 3/4
ID_VS_TAG_ASPECT_169 16/9
ID_VS_BASE_SIZE BaseSize LONG
ANIM OFF
MIN 150
MAX 640
ID_VS_TAG_LOCK LockHotSpots BOOL ANIM
ID_VS_TAG_HOTSPOT_ADD Add BUTTON  
ID_VS_TAG_HOTSPOT_REMOVE Remove BUTTON  
ID_VS_TAG_DYNAMIC_BUTTON Icon BITMAPBUTTON
FIT_H
BUTTON
ANIM OFF
ID_VS_TAG_DYNAMIC_LINK Link LINK ANIM
ID_VS_TAG_DYNAMIC_COMMAND CommandID LONG
FIT_H
ANIM OFF
MIN 0
ID_VS_TAG_DYNAMIC_NAME Text STRING ANIM
ID_VS_TAG_DYNAMIC_ACTION Action LONG ANIM
ID_VS_TAG_ACTION_NONE None
ID_VS_TAG_ACTION_MOVE Move
ID_VS_TAG_ACTION_SCALE Scale
ID_VS_TAG_ACTION_ROTATE Rotate
ID_VS_TAG_ACTION_SPECIAL Command

Example Code

The following code does not use the correct values when setting the data. You should check directly in C4D for the correct values that you should use in place of the ones that are shown. This code is just to show you how to access the values for getting and setting the parameters.

Python

import c4d
from c4d import gui
def main():
    obj = c4d.BaseObject(c4d.Osphere)
    tag = obj.MakeTag(c4d.vstag)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    tag[c4d.ID_VS_TAG_NAME] = "Hello World"
    tag[c4d.ID_VS_TAG_ASPECT] = c4d.ID_VS_TAG_ASPECT_11
    tag[c4d.ID_VS_BASE_SIZE] = 1
    tag[c4d.ID_VS_TAG_LOCK] = True
    tag[c4d.ID_VS_TAG_DYNAMIC_COMMAND] = 1
    tag[c4d.ID_VS_TAG_DYNAMIC_NAME] = "Hello World"
    tag[c4d.ID_VS_TAG_DYNAMIC_ACTION] = c4d.ID_VS_TAG_ACTION_NONE
    
    #Second way, using the base container.
    bc = tag.GetDataInstance()
    bc.SetString(c4d.ID_VS_TAG_NAME,"Hello World")
    bc.SetInt32(c4d.ID_VS_TAG_ASPECT,c4d.ID_VS_TAG_ASPECT_11)
    bc.SetInt32(c4d.ID_VS_BASE_SIZE,1)
    bc.SetBool(c4d.ID_VS_TAG_LOCK,True)
    bc.SetInt32(c4d.ID_VS_TAG_DYNAMIC_COMMAND,1)
    bc.SetString(c4d.ID_VS_TAG_DYNAMIC_NAME,"Hello World")
    bc.SetInt32(c4d.ID_VS_TAG_DYNAMIC_ACTION,c4d.ID_VS_TAG_ACTION_NONE)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../ca2/description/vstag.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Osphere);
    pDoc->InsertObject(pObject);
    pDoc->StartUndo();
    pDoc->AddUndo(UNDOTYPE_NEW,pObject);
    pDoc->EndUndo();
    pDoc->StartUndo();
    BaseTag *pTag = pObject->MakeTag(vstag);
    pDoc->AddUndo(UNDOTYPE_NEW,pTag);
    pDoc->EndUndo();
    pObject->Message(MSG_UPDATE);
    
    //You can set parameters two different ways. 

    //First way              
    //Some objects do not store all their data in the container. You need to use GetParameter()/SetParameter() instead. 

    DESCFLAGS_SET flags = DESCFLAGS_SET_PARAM_SET;
    pTag->SetParameter(DescID(ID_VS_TAG_NAME),GeData("Hello World"),flags);
    pTag->SetParameter(DescID(ID_VS_TAG_ASPECT),GeData(ID_VS_TAG_ASPECT_11),flags);
    pTag->SetParameter(DescID(ID_VS_BASE_SIZE),GeData(1),flags);
    pTag->SetParameter(DescID(ID_VS_TAG_LOCK),GeData(true),flags);
    pTag->SetParameter(DescID(ID_VS_TAG_DYNAMIC_COMMAND),GeData(1),flags);
    pTag->SetParameter(DescID(ID_VS_TAG_DYNAMIC_NAME),GeData("Hello World"),flags);
    pTag->SetParameter(DescID(ID_VS_TAG_DYNAMIC_ACTION),GeData(ID_VS_TAG_ACTION_NONE),flags);
    pTag->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pTag->GetDataInstance();
    bc->SetString(ID_VS_TAG_NAME,"Hello World");
    bc->SetInt32(ID_VS_TAG_ASPECT,ID_VS_TAG_ASPECT_11);
    bc->SetInt32(ID_VS_BASE_SIZE,1);
    bc->SetBool(ID_VS_TAG_LOCK,true);
    bc->SetInt32(ID_VS_TAG_DYNAMIC_COMMAND,1);
    bc->SetString(ID_VS_TAG_DYNAMIC_NAME,"Hello World");
    bc->SetInt32(ID_VS_TAG_DYNAMIC_ACTION,ID_VS_TAG_ACTION_NONE);
    pTag->Message(MSG_UPDATE);                                                      
}
             

Buttons

This node has buttons. Buttons can manually be executed by calling the following code

Python

c4d.CallButton(tag,c4d.ID_VS_TAG_HOTSPOT_ADD)
c4d.CallButton(tag,c4d.ID_VS_TAG_HOTSPOT_REMOVE)
c4d.CallButton(tag,c4d.ID_VS_TAG_DYNAMIC_BUTTON)

C++

DescriptionCommand dc;
dc.id = DescID(ID_VS_TAG_HOTSPOT_ADD);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);

DescriptionCommand dc; dc.id = DescID(ID_VS_TAG_HOTSPOT_REMOVE); pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);
DescriptionCommand dc; dc.id = DescID(ID_VS_TAG_DYNAMIC_BUTTON); pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);