IDs and information for Omstream

Omstream

Attributes

• ENGLISH NAME : X-ParticlesTendrilModifier
• NAME : Omstream
• INCLUDE : Obase
• PATH : res/description/omstream.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMSTREAM

Elements

ID	UI Name	Type	Parameters	Cycle
XMST_STREAM_ENABLED	Enabled	BOOL
XMST_STREAM_MODE	Mode	LONG		STREAM_MODE_INDEP Independent STREAM_MODE_ACTION Action-Controlled
XMST_STREAM_INTERVAL	Interval	BASETIME
XMST_STREAM_LENGTH_SCENE	SceneLengthTendril	BOOL	ANIM
XMST_STREAM_LIFESPAN	TendrilLength	BASETIME
XMST_STREAM_LIFESPAN_VAR	Variation	BASETIME
XMST_STREAM_MAXCOUNT	Max.TendrilParticles	LONG	MIN 0 MINSLIDER 0 MAXSLIDER 1000 CUSTOMGUI LONGSLIDER
XMST_STREAM_FOLLOWTRAIL	FollowSource	BOOL
XMST_STREAM_FREEZESOURCE	FreezeSource	BOOL
XMST_STREAM_FREEZEAT	AtAge	BASETIME
XMST_STREAM_FREEZE_ON_FREEZE	FreezeonSourceFreeze	BOOL
XMST_STREAM_STOP_STREAM_FREEZE	StopStreamingonSourceFreeze	BOOL
XMST_STREAM_SPEEDMODE	SpeedMode	LONG		STREAM_SPEEDMODE_EMITTER UseEmitter STREAM_SPEEDMODE_INHERIT InheritfromSource STREAM_SPEEDMODE_SET Set
XMST_STREAM_SPEED	Speed	REAL	UNIT METER MIN 0.0 MINSLIDER 0.0 MAXSLIDER 1000.0 CUSTOMGUI REALSLIDER
XMST_STREAM_OBJECT	RootObject	LINK
XMST_STREAM_NEWGROUP	TendrilGroup	LINK
XMST_STREAM_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.Omstream)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMST_STREAM_ENABLED] = True
    obj[c4d.XMST_STREAM_MODE] = c4d.STREAM_MODE_INDEP
    obj[c4d.XMST_STREAM_LENGTH_SCENE] = True
    obj[c4d.XMST_STREAM_MAXCOUNT] = 1
    obj[c4d.XMST_STREAM_FOLLOWTRAIL] = True
    obj[c4d.XMST_STREAM_FREEZESOURCE] = True
    obj[c4d.XMST_STREAM_FREEZE_ON_FREEZE] = True
    obj[c4d.XMST_STREAM_STOP_STREAM_FREEZE] = True
    obj[c4d.XMST_STREAM_SPEEDMODE] = c4d.STREAM_SPEEDMODE_EMITTER
    obj[c4d.XMST_STREAM_SPEED] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMST_STREAM_ENABLED,True)
    bc.SetInt32(c4d.XMST_STREAM_MODE,c4d.STREAM_MODE_INDEP)
    bc.SetBool(c4d.XMST_STREAM_LENGTH_SCENE,True)
    bc.SetInt32(c4d.XMST_STREAM_MAXCOUNT,1)
    bc.SetBool(c4d.XMST_STREAM_FOLLOWTRAIL,True)
    bc.SetBool(c4d.XMST_STREAM_FREEZESOURCE,True)
    bc.SetBool(c4d.XMST_STREAM_FREEZE_ON_FREEZE,True)
    bc.SetBool(c4d.XMST_STREAM_STOP_STREAM_FREEZE,True)
    bc.SetInt32(c4d.XMST_STREAM_SPEEDMODE,c4d.STREAM_SPEEDMODE_EMITTER)
    bc.SetFloat(c4d.XMST_STREAM_SPEED,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omstream.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omstream);
    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(XMST_STREAM_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMST_STREAM_MODE),GeData(STREAM_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMST_STREAM_LENGTH_SCENE),GeData(true),flags);
    pObject->SetParameter(DescID(XMST_STREAM_MAXCOUNT),GeData(1),flags);
    pObject->SetParameter(DescID(XMST_STREAM_FOLLOWTRAIL),GeData(true),flags);
    pObject->SetParameter(DescID(XMST_STREAM_FREEZESOURCE),GeData(true),flags);
    pObject->SetParameter(DescID(XMST_STREAM_FREEZE_ON_FREEZE),GeData(true),flags);
    pObject->SetParameter(DescID(XMST_STREAM_STOP_STREAM_FREEZE),GeData(true),flags);
    pObject->SetParameter(DescID(XMST_STREAM_SPEEDMODE),GeData(STREAM_SPEEDMODE_EMITTER),flags);
    pObject->SetParameter(DescID(XMST_STREAM_SPEED),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMST_STREAM_ENABLED,true);
    bc->SetInt32(XMST_STREAM_MODE,STREAM_MODE_INDEP);
    bc->SetBool(XMST_STREAM_LENGTH_SCENE,true);
    bc->SetInt32(XMST_STREAM_MAXCOUNT,1);
    bc->SetBool(XMST_STREAM_FOLLOWTRAIL,true);
    bc->SetBool(XMST_STREAM_FREEZESOURCE,true);
    bc->SetBool(XMST_STREAM_FREEZE_ON_FREEZE,true);
    bc->SetBool(XMST_STREAM_STOP_STREAM_FREEZE,true);
    bc->SetInt32(XMST_STREAM_SPEEDMODE,STREAM_SPEEDMODE_EMITTER);
    bc->SetFloat(XMST_STREAM_SPEED,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}