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.

Description Omscale

IDs and information for Omscale

Omscale

Attributes

  • ENGLISH NAME : X-ParticlesScaleModifier
  • NAME : Omscale
  • INCLUDE : Obase
  • PATH : res/description/omscale.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): OMSCALE

Elements

ID UI Name Type Parameters Cycle
XMSC_SCALE_ENABLED Enabled BOOL  
XMSC_SCALE_MODE Mode LONG  
SCALE_MODE_INDEP Independent
SCALE_MODE_ACTION Action-Controlled
XMSC_SCALE_PARAMETER ParametertoChange LONG  
SCALE_PARAM_GEOM ParticleScale
SCALE_PARAM_RADIUS ParticleRadius
SCALE_PARAM_MASS ParticleMass
XMSC_SCALE_OPERATION Operation LONG  
SCALE_OP_SET ChangeValueOverTime
SCALE_OP_ABSOLUTE SetValue
SCALE_OP_JIGGLE Jiggle
SCALE_OP_SPLINE UseSpline
SCALE_OP_SPEED ScalebySpeed
SCALE_OP_ACCEL ScalebyAcceleration
XMSC_SCALE_ABSOLUTE ScaleValue VECTOR
UNIT REAL
STEP 0.01
MIN 0.0
XMSC_SCALE_DELTA ScaleChange VECTOR
UNIT REAL
STEP 0.01
XMSC_SCALE_DELTA_VAR JiggleVariation REAL
UNIT REAL
STEP 0.01
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 1.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_USELIMIT ClamptoScaleLimit BOOL  
XMSC_SCALE_SCALELIMIT_MIN LowerScaleLimit VECTOR
MIN 0.0
STEP 0.1
XMSC_SCALE_SCALELIMIT_MAX UpperScaleLimit VECTOR
MIN 0.0
STEP 0.1
XMSC_SCALE_SCALE_SCALERANDOM ClampWithinRange BOOL  
XMSC_SCALE_RADIUS_ABSOLUTE RadiusValue REAL
UNIT METER
STEP 0.1
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 20.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_RADIUS_DELTA RadiusChange REAL
UNIT METER
STEP 0.01
MINSLIDER -5.0
MAXSLIDER 5.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_RADIUS_USELIMIT ClamptoRadiusLimit BOOL  
XMSC_SCALE_RADIUS_SCALELIMIT_MIN LowerRadiusLimit REAL
UNIT METER
MIN 0.0
STEP 0.1
MINSLIDER 0.0
MAXSLIDER 50.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_RADIUS_SCALELIMIT_MAX UpperRadiusLimit REAL
UNIT METER
MIN 0.0
STEP 0.1
MINSLIDER 0.0
MAXSLIDER 50.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_RADIUS_SCALERANDOM ClampWithinRange BOOL  
XMSC_SCALE_MASS_ABSOLUTE MassValue REAL
STEP 0.1
MIN 0.0
MINSLIDER 0.0
MAXSLIDER 20.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_MASS_DELTA MassChange REAL
STEP 0.01
MINSLIDER -5.0
MAXSLIDER 5.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_MASS_USELIMIT ClamptoMassLimit BOOL  
XMSC_SCALE_MASS_SCALELIMIT_MIN LowerMassLimit REAL
MIN 0.0
STEP 0.1
MINSLIDER 0.0
MAXSLIDER 50.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_MASS_SCALELIMIT_MAX UpperMassLimit REAL
MIN 0.0
STEP 0.1
MINSLIDER 0.0
MAXSLIDER 50.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_MASS_SCALERANDOM ClampWithinRange BOOL  
XMSC_SCALE_REMAP_FALLOFF RemapFalloffValue BOOL  
XMSC_SCALE_SPLINE ScaleSpline SPLINE
Y_MIN 0.0
Y_MAX 2.0
X_MIN 0.0
X_MAX 1.0
X_STEPS 0.01
Y_STEPS 0.01
XMSC_SCALE_YMAX MaximumScale REAL
MIN 0.0
STEP 0.01
MINSLIDER 0.0
MAXSLIDER 10.0
CUSTOMGUI REALSLIDER
XMSC_SCALE_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.Omscale)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.XMSC_SCALE_ENABLED] = True
    obj[c4d.XMSC_SCALE_MODE] = c4d.SCALE_MODE_INDEP
    obj[c4d.XMSC_SCALE_PARAMETER] = c4d.SCALE_PARAM_GEOM
    obj[c4d.XMSC_SCALE_OPERATION] = c4d.SCALE_OP_SET
    obj[c4d.XMSC_SCALE_ABSOLUTE] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.XMSC_SCALE_DELTA] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.XMSC_SCALE_DELTA_VAR] = 0.1
    obj[c4d.XMSC_SCALE_USELIMIT] = True
    obj[c4d.XMSC_SCALE_SCALELIMIT_MIN] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.XMSC_SCALE_SCALELIMIT_MAX] = c4d.Vector(1.0,1.0,1.0)
    obj[c4d.XMSC_SCALE_SCALE_SCALERANDOM] = True
    obj[c4d.XMSC_SCALE_RADIUS_ABSOLUTE] = 0.1
    obj[c4d.XMSC_SCALE_RADIUS_DELTA] = 0.1
    obj[c4d.XMSC_SCALE_RADIUS_USELIMIT] = True
    obj[c4d.XMSC_SCALE_RADIUS_SCALELIMIT_MIN] = 0.1
    obj[c4d.XMSC_SCALE_RADIUS_SCALELIMIT_MAX] = 0.1
    obj[c4d.XMSC_SCALE_RADIUS_SCALERANDOM] = True
    obj[c4d.XMSC_SCALE_MASS_ABSOLUTE] = 0.1
    obj[c4d.XMSC_SCALE_MASS_DELTA] = 0.1
    obj[c4d.XMSC_SCALE_MASS_USELIMIT] = True
    obj[c4d.XMSC_SCALE_MASS_SCALELIMIT_MIN] = 0.1
    obj[c4d.XMSC_SCALE_MASS_SCALELIMIT_MAX] = 0.1
    obj[c4d.XMSC_SCALE_MASS_SCALERANDOM] = True
    obj[c4d.XMSC_SCALE_REMAP_FALLOFF] = True
    obj[c4d.XMSC_SCALE_YMAX] = 0.1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetBool(c4d.XMSC_SCALE_ENABLED,True)
    bc.SetInt32(c4d.XMSC_SCALE_MODE,c4d.SCALE_MODE_INDEP)
    bc.SetInt32(c4d.XMSC_SCALE_PARAMETER,c4d.SCALE_PARAM_GEOM)
    bc.SetInt32(c4d.XMSC_SCALE_OPERATION,c4d.SCALE_OP_SET)
    bc.SetVector(c4d.XMSC_SCALE_ABSOLUTE, c4d.Vector(1.0,1.0,1.0)
    bc.SetVector(c4d.XMSC_SCALE_DELTA, c4d.Vector(1.0,1.0,1.0)
    bc.SetFloat(c4d.XMSC_SCALE_DELTA_VAR,0.1)
    bc.SetBool(c4d.XMSC_SCALE_USELIMIT,True)
    bc.SetVector(c4d.XMSC_SCALE_SCALELIMIT_MIN, c4d.Vector(1.0,1.0,1.0)
    bc.SetVector(c4d.XMSC_SCALE_SCALELIMIT_MAX, c4d.Vector(1.0,1.0,1.0)
    bc.SetBool(c4d.XMSC_SCALE_SCALE_SCALERANDOM,True)
    bc.SetFloat(c4d.XMSC_SCALE_RADIUS_ABSOLUTE,0.1)
    bc.SetFloat(c4d.XMSC_SCALE_RADIUS_DELTA,0.1)
    bc.SetBool(c4d.XMSC_SCALE_RADIUS_USELIMIT,True)
    bc.SetFloat(c4d.XMSC_SCALE_RADIUS_SCALELIMIT_MIN,0.1)
    bc.SetFloat(c4d.XMSC_SCALE_RADIUS_SCALELIMIT_MAX,0.1)
    bc.SetBool(c4d.XMSC_SCALE_RADIUS_SCALERANDOM,True)
    bc.SetFloat(c4d.XMSC_SCALE_MASS_ABSOLUTE,0.1)
    bc.SetFloat(c4d.XMSC_SCALE_MASS_DELTA,0.1)
    bc.SetBool(c4d.XMSC_SCALE_MASS_USELIMIT,True)
    bc.SetFloat(c4d.XMSC_SCALE_MASS_SCALELIMIT_MIN,0.1)
    bc.SetFloat(c4d.XMSC_SCALE_MASS_SCALELIMIT_MAX,0.1)
    bc.SetBool(c4d.XMSC_SCALE_MASS_SCALERANDOM,True)
    bc.SetBool(c4d.XMSC_SCALE_REMAP_FALLOFF,True)
    bc.SetFloat(c4d.XMSC_SCALE_YMAX,0.1)

if __name__=='__main__':
    main()

C++

#include "c4d.h"
#include "../res/description/omscale.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Omscale);
    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(XMSC_SCALE_ENABLED),GeData(true),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_MODE),GeData(SCALE_MODE_INDEP),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_PARAMETER),GeData(SCALE_PARAM_GEOM),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_OPERATION),GeData(SCALE_OP_SET),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_ABSOLUTE),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_DELTA),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_DELTA_VAR),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_USELIMIT),GeData(true),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_SCALELIMIT_MIN),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_SCALELIMIT_MAX),GeData(Vector(1.0,1.0,1.0)),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_SCALE_SCALERANDOM),GeData(true),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_RADIUS_ABSOLUTE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_RADIUS_DELTA),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_RADIUS_USELIMIT),GeData(true),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_RADIUS_SCALELIMIT_MIN),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_RADIUS_SCALELIMIT_MAX),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_RADIUS_SCALERANDOM),GeData(true),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_MASS_ABSOLUTE),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_MASS_DELTA),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_MASS_USELIMIT),GeData(true),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_MASS_SCALELIMIT_MIN),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_MASS_SCALELIMIT_MAX),GeData(0.1),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_MASS_SCALERANDOM),GeData(true),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_REMAP_FALLOFF),GeData(true),flags);
    pObject->SetParameter(DescID(XMSC_SCALE_YMAX),GeData(0.1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetBool(XMSC_SCALE_ENABLED,true);
    bc->SetInt32(XMSC_SCALE_MODE,SCALE_MODE_INDEP);
    bc->SetInt32(XMSC_SCALE_PARAMETER,SCALE_PARAM_GEOM);
    bc->SetInt32(XMSC_SCALE_OPERATION,SCALE_OP_SET);
    bc->SetVector(XMSC_SCALE_ABSOLUTE, c4d.Vector(1.0,1.0,1.0);
    bc->SetVector(XMSC_SCALE_DELTA, c4d.Vector(1.0,1.0,1.0);
    bc->SetFloat(XMSC_SCALE_DELTA_VAR,0.1);
    bc->SetBool(XMSC_SCALE_USELIMIT,true);
    bc->SetVector(XMSC_SCALE_SCALELIMIT_MIN, c4d.Vector(1.0,1.0,1.0);
    bc->SetVector(XMSC_SCALE_SCALELIMIT_MAX, c4d.Vector(1.0,1.0,1.0);
    bc->SetBool(XMSC_SCALE_SCALE_SCALERANDOM,true);
    bc->SetFloat(XMSC_SCALE_RADIUS_ABSOLUTE,0.1);
    bc->SetFloat(XMSC_SCALE_RADIUS_DELTA,0.1);
    bc->SetBool(XMSC_SCALE_RADIUS_USELIMIT,true);
    bc->SetFloat(XMSC_SCALE_RADIUS_SCALELIMIT_MIN,0.1);
    bc->SetFloat(XMSC_SCALE_RADIUS_SCALELIMIT_MAX,0.1);
    bc->SetBool(XMSC_SCALE_RADIUS_SCALERANDOM,true);
    bc->SetFloat(XMSC_SCALE_MASS_ABSOLUTE,0.1);
    bc->SetFloat(XMSC_SCALE_MASS_DELTA,0.1);
    bc->SetBool(XMSC_SCALE_MASS_USELIMIT,true);
    bc->SetFloat(XMSC_SCALE_MASS_SCALELIMIT_MIN,0.1);
    bc->SetFloat(XMSC_SCALE_MASS_SCALELIMIT_MAX,0.1);
    bc->SetBool(XMSC_SCALE_MASS_SCALERANDOM,true);
    bc->SetBool(XMSC_SCALE_REMAP_FALLOFF,true);
    bc->SetFloat(XMSC_SCALE_YMAX,0.1);
    pObject->Message(MSG_UPDATE);                                                      
}