IDs and information for Omsprite

Omsprite

Attributes

• ENGLISH NAME : X-ParticlesSpriteModifier
• NAME : Omsprite
• INCLUDE : Obase
• PATH : res/description/omsprite.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMSPRITE

Elements

ID	UI Name	Type	Parameters	Cycle
XMSR_SPRITE_ENABLED	Enabled	BOOL
XMSR_SPRITE_MODE	Mode	LONG		SPRITE_MODE_INDEP Independent SPRITE_MODE_ACTION Action-Controlled
XMSR_SPRITE_GENERATE	GenerateSprite	BOOL
XMSR_SPRITE_TYPE_CHANGE	ChangeSprite	BOOL
XMSR_SPRITE_TYPE	SpriteType	LONG		XMSR_SPRITE_DOT Cube XMSR_SPRITE_TICK Cross XMSR_SPRITE_PLACARD Placard XMSR_SPRITE_SPHERE Sphere XMSR_SPRITE_CONE Cone XMSR_SPRITE_PYRAMID Pyramid XMSR_SPRITE_DISC Disc XMSR_SPRITE_3PLANE 3-Plane XMSR_SPRITE_LIGHT Light XMSR_SPRITE_POINT Points XMSR_SPRITE_TEXT Text
XMSR_SPRITE_MAT_CHANGE	ChangeMaterial	BOOL
XMSR_SPRITE_MAT	MaterialIndex	LONG	MIN 1 STEP 1 MINSLIDER 1 MAXSLIDER 10 CUSTOMGUI LONGSLIDER
XMSR_SPRITE_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.Omsprite)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMSR_SPRITE_ENABLED] = True
    obj[c4d.XMSR_SPRITE_MODE] = c4d.SPRITE_MODE_INDEP
    obj[c4d.XMSR_SPRITE_GENERATE] = True
    obj[c4d.XMSR_SPRITE_TYPE_CHANGE] = True
    obj[c4d.XMSR_SPRITE_TYPE] = c4d.XMSR_SPRITE_DOT
    obj[c4d.XMSR_SPRITE_MAT_CHANGE] = True
    obj[c4d.XMSR_SPRITE_MAT] = 1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMSR_SPRITE_ENABLED,True)
    bc.SetInt32(c4d.XMSR_SPRITE_MODE,c4d.SPRITE_MODE_INDEP)
    bc.SetBool(c4d.XMSR_SPRITE_GENERATE,True)
    bc.SetBool(c4d.XMSR_SPRITE_TYPE_CHANGE,True)
    bc.SetInt32(c4d.XMSR_SPRITE_TYPE,c4d.XMSR_SPRITE_DOT)
    bc.SetBool(c4d.XMSR_SPRITE_MAT_CHANGE,True)
    bc.SetInt32(c4d.XMSR_SPRITE_MAT,1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omsprite.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omsprite);
    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(XMSR_SPRITE_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMSR_SPRITE_MODE),GeData(SPRITE_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMSR_SPRITE_GENERATE),GeData(true),flags);
    pObject->SetParameter(DescID(XMSR_SPRITE_TYPE_CHANGE),GeData(true),flags);
    pObject->SetParameter(DescID(XMSR_SPRITE_TYPE),GeData(XMSR_SPRITE_DOT),flags);
    pObject->SetParameter(DescID(XMSR_SPRITE_MAT_CHANGE),GeData(true),flags);
    pObject->SetParameter(DescID(XMSR_SPRITE_MAT),GeData(1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMSR_SPRITE_ENABLED,true);
    bc->SetInt32(XMSR_SPRITE_MODE,SPRITE_MODE_INDEP);
    bc->SetBool(XMSR_SPRITE_GENERATE,true);
    bc->SetBool(XMSR_SPRITE_TYPE_CHANGE,true);
    bc->SetInt32(XMSR_SPRITE_TYPE,XMSR_SPRITE_DOT);
    bc->SetBool(XMSR_SPRITE_MAT_CHANGE,true);
    bc->SetInt32(XMSR_SPRITE_MAT,1);
    pObject->Message(MSG_UPDATE);                                                      
}