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 Omtext

Omtext

Attributes

  • ENGLISH NAME : X-ParticlesTextModifier
  • NAME : Omtext
  • INCLUDE : Obase
  • PATH : res/description/omtext.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMTEXT

Elements

ID UI Name Type Parameters Cycle
XTEX_TEXT_ENABLED Enabled BOOL  
XTEX_TEXT_MODE Mode LONG  
MTEXT_MODE_INDEP Independent
MTEXT_MODE_ACTION Action-Controlled
XTEX_TEXT_THRESHOLD Threshold REAL
UNIT PERCENT
MIN 0.0
MAX 100.0
MINSLIDER 0.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
XTEX_TEXT_TEXTMODE TextMode LONG  
MTEXT_MODE_ALPHA Alphabet
MTEXT_MODE_NUMERIC Numbers
MTEXT_MODE_BOTH AlphabetandNumbers
MTEXT_MODE_USER UserText
MTEXT_MODE_USER_NUMERIC UserTextandNumbers
XTEX_TEXT_ALPHA_MODE AlphabetMode LONG  
MALPHA_MODE_INCREMENT Increment
MALPHA_MODE_DECREMENT Decrement
XTEX_TEXT_ALPHA_CASE Case LONG  
MCASE_MODE_UPPER AllUpper
MCASE_MODE_LOWER AllLower
MCASE_MODE_BOTH MixedUpperandLower
XTEX_TEXT_NUMERIC_MODE NumericMode LONG  
MNUMERIC_MODE_INCREMENT Increment
MNUMERIC_MODE_DECREMENT Decrement
XTEX_TEXT_TIME ChangeEvery BASETIME  
XTEX_TEXT_NUMERIC_START LowerLimit LONG
MINSLIDER -1000
MAXSLIDER 1000
CUSTOMGUI LONGSLIDER
XTEX_TEXT_NUMERIC_END UpperLimit LONG
MINSLIDER -1000
MAXSLIDER 1000
CUSTOMGUI LONGSLIDER
XTEX_TEXT_USER_TEXT Text STRING  
XTEX_TEXT_GROUP Groups IN_EXCLUDE
NUM_FLAGS 2
INIT_STATE 3
SEND_SELCHNGMSG 1
SCALE_V
IMAGE_01_ON 1009316
IMAGE_01_OFF 1009320
IMAGE_02_ON 300000231
IMAGE_02_OFF 300000230

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.Omtext)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XTEX_TEXT_ENABLED] = True
    obj[c4d.XTEX_TEXT_MODE] = c4d.MTEXT_MODE_INDEP
    obj[c4d.XTEX_TEXT_THRESHOLD] = 0.1
    obj[c4d.XTEX_TEXT_TEXTMODE] = c4d.MTEXT_MODE_ALPHA
    obj[c4d.XTEX_TEXT_ALPHA_MODE] = c4d.MALPHA_MODE_INCREMENT
    obj[c4d.XTEX_TEXT_ALPHA_CASE] = c4d.MCASE_MODE_UPPER
    obj[c4d.XTEX_TEXT_NUMERIC_MODE] = c4d.MNUMERIC_MODE_INCREMENT
    obj[c4d.XTEX_TEXT_NUMERIC_START] = 1
    obj[c4d.XTEX_TEXT_NUMERIC_END] = 1
    obj[c4d.XTEX_TEXT_USER_TEXT] = "Hello World"
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XTEX_TEXT_ENABLED,True)
    bc.SetInt32(c4d.XTEX_TEXT_MODE,c4d.MTEXT_MODE_INDEP)
    bc.SetFloat(c4d.XTEX_TEXT_THRESHOLD,0.1)
    bc.SetInt32(c4d.XTEX_TEXT_TEXTMODE,c4d.MTEXT_MODE_ALPHA)
    bc.SetInt32(c4d.XTEX_TEXT_ALPHA_MODE,c4d.MALPHA_MODE_INCREMENT)
    bc.SetInt32(c4d.XTEX_TEXT_ALPHA_CASE,c4d.MCASE_MODE_UPPER)
    bc.SetInt32(c4d.XTEX_TEXT_NUMERIC_MODE,c4d.MNUMERIC_MODE_INCREMENT)
    bc.SetInt32(c4d.XTEX_TEXT_NUMERIC_START,1)
    bc.SetInt32(c4d.XTEX_TEXT_NUMERIC_END,1)
    bc.SetString(c4d.XTEX_TEXT_USER_TEXT,"Hello World")

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omtext.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omtext);
    pDoc->InsertObject(pObject);
    pDoc->StartUndo();
    pDoc->AddUndo(UNDO_NEW,pObject);
    pDoc->EndUndo();
    EventAdd(EVENT_FORCEREDRAW);
    
    //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;
    pObject->SetParameter(DescID(XTEX_TEXT_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XTEX_TEXT_MODE),GeData(MTEXT_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XTEX_TEXT_THRESHOLD),GeData(0.1),flags);
    pObject->SetParameter(DescID(XTEX_TEXT_TEXTMODE),GeData(MTEXT_MODE_ALPHA),flags);
    pObject->SetParameter(DescID(XTEX_TEXT_ALPHA_MODE),GeData(MALPHA_MODE_INCREMENT),flags);
    pObject->SetParameter(DescID(XTEX_TEXT_ALPHA_CASE),GeData(MCASE_MODE_UPPER),flags);
    pObject->SetParameter(DescID(XTEX_TEXT_NUMERIC_MODE),GeData(MNUMERIC_MODE_INCREMENT),flags);
    pObject->SetParameter(DescID(XTEX_TEXT_NUMERIC_START),GeData(1),flags);
    pObject->SetParameter(DescID(XTEX_TEXT_NUMERIC_END),GeData(1),flags);
    pObject->SetParameter(DescID(XTEX_TEXT_USER_TEXT),GeData("Hello World"),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XTEX_TEXT_ENABLED,true);
    bc->SetInt32(XTEX_TEXT_MODE,MTEXT_MODE_INDEP);
    bc->SetFloat(XTEX_TEXT_THRESHOLD,0.1);
    bc->SetInt32(XTEX_TEXT_TEXTMODE,MTEXT_MODE_ALPHA);
    bc->SetInt32(XTEX_TEXT_ALPHA_MODE,MALPHA_MODE_INCREMENT);
    bc->SetInt32(XTEX_TEXT_ALPHA_CASE,MCASE_MODE_UPPER);
    bc->SetInt32(XTEX_TEXT_NUMERIC_MODE,MNUMERIC_MODE_INCREMENT);
    bc->SetInt32(XTEX_TEXT_NUMERIC_START,1);
    bc->SetInt32(XTEX_TEXT_NUMERIC_END,1);
    bc->SetString(XTEX_TEXT_USER_TEXT,"Hello World");
    pObject->Message(MSG_UPDATE);                                                      
}