IDs and information for Omvecmask

Omvecmask

Attributes

• ENGLISH NAME : X-ParticlesLimitModifier
• NAME : Omvecmask
• INCLUDE : Obase
• PATH : res/description/omvecmask.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): OMVECMASK

Elements

ID	UI Name	Type	Parameters	Cycle
XMVM_VECMASK_ENABLED	Enabled	BOOL
XMVM_VECMASK_MODE	Mode	LONG		VECMASK_MODE_INDEP Independent VECMASK_MODE_ACTION Action-Controlled
XMVM_VECMASK_EMITTERMATRIX	UseEmitterSpace	BOOL
XMVM_VECMASK_MASK	AxisLimit	VECTOR	UNIT PERCENT MIN 0.0 MAX 100.0 STEP 1.0
XMVM_VECMASK_PLANELIMITX	X-AxisRestriction	LONG		VPLANELIMITX_NONE None VPLANELIMITX_POS X+ VPLANELIMITX_NEG X-
XMVM_VECMASK_PLANELIMITY	Y-AxisRestriction	LONG		VPLANELIMITY_NONE None VPLANELIMITY_POS Y+ VPLANELIMITY_NEG Y-
XMVM_VECMASK_PLANELIMITZ	Z-AxisRestriction	LONG		VPLANELIMITZ_NONE None VPLANELIMITZ_POS Z+ VPLANELIMITZ_NEG Z-
XMVM_VECMASK_NOBANK	NoBanking	BOOL
XMVM_VECMASK_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.Omvecmask)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMVM_VECMASK_ENABLED] = True
    obj[c4d.XMVM_VECMASK_MODE] = c4d.VECMASK_MODE_INDEP
    obj[c4d.XMVM_VECMASK_EMITTERMATRIX] = True
    obj[c4d.XMVM_VECMASK_MASK] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.XMVM_VECMASK_PLANELIMITX] = c4d.VPLANELIMITX_NONE
    obj[c4d.XMVM_VECMASK_PLANELIMITY] = c4d.VPLANELIMITY_NONE
    obj[c4d.XMVM_VECMASK_PLANELIMITZ] = c4d.VPLANELIMITZ_NONE
    obj[c4d.XMVM_VECMASK_NOBANK] = True
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMVM_VECMASK_ENABLED,True)
    bc.SetInt32(c4d.XMVM_VECMASK_MODE,c4d.VECMASK_MODE_INDEP)
    bc.SetBool(c4d.XMVM_VECMASK_EMITTERMATRIX,True)
    bc.SetVector(c4d.XMVM_VECMASK_MASK, c4d.Vector(1.0,1.0,1.0)
    bc.SetInt32(c4d.XMVM_VECMASK_PLANELIMITX,c4d.VPLANELIMITX_NONE)
    bc.SetInt32(c4d.XMVM_VECMASK_PLANELIMITY,c4d.VPLANELIMITY_NONE)
    bc.SetInt32(c4d.XMVM_VECMASK_PLANELIMITZ,c4d.VPLANELIMITZ_NONE)
    bc.SetBool(c4d.XMVM_VECMASK_NOBANK,True)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/omvecmask.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omvecmask);
    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(XMVM_VECMASK_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMVM_VECMASK_MODE),GeData(VECMASK_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMVM_VECMASK_EMITTERMATRIX),GeData(true),flags);
    pObject->SetParameter(DescID(XMVM_VECMASK_MASK),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(XMVM_VECMASK_PLANELIMITX),GeData(VPLANELIMITX_NONE),flags);
    pObject->SetParameter(DescID(XMVM_VECMASK_PLANELIMITY),GeData(VPLANELIMITY_NONE),flags);
    pObject->SetParameter(DescID(XMVM_VECMASK_PLANELIMITZ),GeData(VPLANELIMITZ_NONE),flags);
    pObject->SetParameter(DescID(XMVM_VECMASK_NOBANK),GeData(true),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMVM_VECMASK_ENABLED,true);
    bc->SetInt32(XMVM_VECMASK_MODE,VECMASK_MODE_INDEP);
    bc->SetBool(XMVM_VECMASK_EMITTERMATRIX,true);
    bc->SetVector(XMVM_VECMASK_MASK, c4d.Vector(1.0,1.0,1.0);
    bc->SetInt32(XMVM_VECMASK_PLANELIMITX,VPLANELIMITX_NONE);
    bc->SetInt32(XMVM_VECMASK_PLANELIMITY,VPLANELIMITY_NONE);
    bc->SetInt32(XMVM_VECMASK_PLANELIMITZ,VPLANELIMITZ_NONE);
    bc->SetBool(XMVM_VECMASK_NOBANK,true);
    pObject->Message(MSG_UPDATE);                                                      
}