IDs and information for Osplinetext

Osplinetext

Attributes

• ENGLISH NAME : TextSplineObject
• NAME : Osplinetext
• INCLUDE : Obase
• INCLUDE : Osplineprimitive
• PATH : objects/description/osplinetext.res
• PLUGIN : objects
• MAXON online help (may not exist): OSPLINETEXT

Elements

ID	UI Name	Type	Parameters	Cycle
PRIM_TEXT_TEXT	TextSpline	STRING	CUSTOMGUI
PRIM_TEXT_FONT	Font	FONT	OPEN
PRIM_TEXT_ALIGN	Align	LONG		PRIM_TEXT_ALIGN_LEFT Left PRIM_TEXT_ALIGN_MIDDLE Middle PRIM_TEXT_ALIGN_RIGHT Right
PRIM_TEXT_HEIGHT	Height	REAL	UNIT
PRIM_TEXT_HSPACING	HorizontalSpacing	REAL	UNIT
PRIM_TEXT_VSPACING	VerticalSpacing	REAL	UNIT
PRIM_TEXT_SEPARATE	SeparateLetters	BOOL
PRIM_TEXT_KERNING	Kerning	KERNING

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.Osplinetext)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.PRIM_TEXT_TEXT] = "Hello World"
    obj[c4d.PRIM_TEXT_ALIGN] = c4d.PRIM_TEXT_ALIGN_LEFT
    obj[c4d.PRIM_TEXT_HEIGHT] = 0.1
    obj[c4d.PRIM_TEXT_HSPACING] = 0.1
    obj[c4d.PRIM_TEXT_VSPACING] = 0.1
    obj[c4d.PRIM_TEXT_SEPARATE] = True
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetString(c4d.PRIM_TEXT_TEXT,"Hello World")
    bc.SetInt32(c4d.PRIM_TEXT_ALIGN,c4d.PRIM_TEXT_ALIGN_LEFT)
    bc.SetFloat(c4d.PRIM_TEXT_HEIGHT,0.1)
    bc.SetFloat(c4d.PRIM_TEXT_HSPACING,0.1)
    bc.SetFloat(c4d.PRIM_TEXT_VSPACING,0.1)
    bc.SetBool(c4d.PRIM_TEXT_SEPARATE,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../objects/description/osplinetext.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Osplinetext);
    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(PRIM_TEXT_TEXT),GeData("Hello World"),flags);
    pObject->SetParameter(DescID(PRIM_TEXT_ALIGN),GeData(PRIM_TEXT_ALIGN_LEFT),flags);
    pObject->SetParameter(DescID(PRIM_TEXT_HEIGHT),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_TEXT_HSPACING),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_TEXT_VSPACING),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_TEXT_SEPARATE),GeData(true),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetString(PRIM_TEXT_TEXT,"Hello World");
    bc->SetInt32(PRIM_TEXT_ALIGN,PRIM_TEXT_ALIGN_LEFT);
    bc->SetFloat(PRIM_TEXT_HEIGHT,0.1);
    bc->SetFloat(PRIM_TEXT_HSPACING,0.1);
    bc->SetFloat(PRIM_TEXT_VSPACING,0.1);
    bc->SetBool(PRIM_TEXT_SEPARATE,true);
    pObject->Message(MSG_UPDATE);                                                      
}