IDs and information for Osplinehelix

Osplinehelix

Attributes

• ENGLISH NAME : HelixObject
• NAME : Osplinehelix
• INCLUDE : Obase
• INCLUDE : Osplineprimitive
• PATH : objects/description/osplinehelix.res
• PLUGIN : objects
• MAXON online help (may not exist): OSPLINEHELIX

Elements

ID	UI Name	Type	Parameters	Cycle
PRIM_HELIX_RADIUS1	StartRadius	REAL	MIN 0.0 UNIT METER
PRIM_HELIX_START	StartAngle	REAL	UNIT
PRIM_HELIX_RADIUS2	EndRadius	REAL	MIN 0.0 UNIT METER
PRIM_HELIX_END	EndAngle	REAL	UNIT
PRIM_HELIX_RADIALBIAS	RadialBias	REAL	UNIT PERCENT MIN 0.0 MAX 100.0
PRIM_HELIX_HEIGHT	Height	REAL	UNIT METER MIN 0.0
PRIM_HELIX_HEIGHTBIAS	HeightBias	REAL	UNIT PERCENT MIN 0.0 MAX 100.0
PRIM_HELIX_SUB	Subdivision	LONG	MIN

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.Osplinehelix)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    obj[c4d.PRIM_HELIX_RADIUS1] = 0.1
    obj[c4d.PRIM_HELIX_START] = 0.1
    obj[c4d.PRIM_HELIX_RADIUS2] = 0.1
    obj[c4d.PRIM_HELIX_END] = 0.1
    obj[c4d.PRIM_HELIX_RADIALBIAS] = 0.1
    obj[c4d.PRIM_HELIX_HEIGHT] = 0.1
    obj[c4d.PRIM_HELIX_HEIGHTBIAS] = 0.1
    obj[c4d.PRIM_HELIX_SUB] = 1
    
    #Second way, using the base container.
    bc = obj.GetDataInstance()
    bc.SetFloat(c4d.PRIM_HELIX_RADIUS1,0.1)
    bc.SetFloat(c4d.PRIM_HELIX_START,0.1)
    bc.SetFloat(c4d.PRIM_HELIX_RADIUS2,0.1)
    bc.SetFloat(c4d.PRIM_HELIX_END,0.1)
    bc.SetFloat(c4d.PRIM_HELIX_RADIALBIAS,0.1)
    bc.SetFloat(c4d.PRIM_HELIX_HEIGHT,0.1)
    bc.SetFloat(c4d.PRIM_HELIX_HEIGHTBIAS,0.1)
    bc.SetInt32(c4d.PRIM_HELIX_SUB,1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../objects/description/osplinehelix.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Osplinehelix);
    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_HELIX_RADIUS1),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_HELIX_START),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_HELIX_RADIUS2),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_HELIX_END),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_HELIX_RADIALBIAS),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_HELIX_HEIGHT),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_HELIX_HEIGHTBIAS),GeData(0.1),flags);
    pObject->SetParameter(DescID(PRIM_HELIX_SUB),GeData(1),flags);
    pObject->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pObject->GetDataInstance();
    bc->SetFloat(PRIM_HELIX_RADIUS1,0.1);
    bc->SetFloat(PRIM_HELIX_START,0.1);
    bc->SetFloat(PRIM_HELIX_RADIUS2,0.1);
    bc->SetFloat(PRIM_HELIX_END,0.1);
    bc->SetFloat(PRIM_HELIX_RADIALBIAS,0.1);
    bc->SetFloat(PRIM_HELIX_HEIGHT,0.1);
    bc->SetFloat(PRIM_HELIX_HEIGHTBIAS,0.1);
    bc->SetInt32(PRIM_HELIX_SUB,1);
    pObject->Message(MSG_UPDATE);                                                      
}