IDs and information for Txsound

Txsound

Attributes

• ENGLISH NAME : X-ParticlesSoundTag
• NAME : Txsound
• INCLUDE : Texpression
• PATH : res/description/txsound.res
• PLUGIN : X-Particles
• MAXON online help (may not exist): TXSOUND

Elements

ID	UI Name	Type	Parameters	Cycle
TSOUND_WAVFILE	SoundFile	FILENAME	ANIM
TSOUND_ENABLED	DriveBirthrate	BOOL
TSOUND_MULTIPLIER	ReductionFactor	LONG	MIN -100000 MAX 100000 MINSLIDER -1000 MAXSLIDER 1000 CUSTOMGUI LONGSLIDER
TSOUND_THRESHOLD	Threshold	REAL	MIN 0.0 STEP 0.1 MINSLIDER 0.0 MAXSLIDER 100.0 CUSTOMGUI REALSLIDER
TSOUND_SPEED	DriveSpeed	BOOL
TSOUND_SPMULT	SpeedReduction	LONG	MIN 0 MAX 100000 MINSLIDER 0 MAXSLIDER 1000 CUSTOMGUI LONGSLIDER
TSO_HELP_BUTTON		BITMAPBUTTON
TSO_VIDMAN_BUTTON		BITMAPBUTTON
TSOUND_RESET	ResettoDefaults	BUTTON
TSOUND_SAVE_PRESET	SavePreset...	BUTTON
TSOUND_LOAD_PRESET	LoadPreset...	BUTTON

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.Osphere)
    tag = obj.MakeTag(c4d.Txsound)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    tag[c4d.TSOUND_WAVFILE] = "c:\\SomeFile.txt"
    tag[c4d.TSOUND_ENABLED] = True
    tag[c4d.TSOUND_MULTIPLIER] = 1
    tag[c4d.TSOUND_THRESHOLD] = 0.1
    tag[c4d.TSOUND_SPEED] = True
    tag[c4d.TSOUND_SPMULT] = 1
    
    #Second way, using the base container.
    bc = tag.GetDataInstance()
    bc.SetFileName(c4d.TSOUND_WAVFILE,"c:\\SomeFile.txt")
    bc.SetBool(c4d.TSOUND_ENABLED,True)
    bc.SetInt32(c4d.TSOUND_MULTIPLIER,1)
    bc.SetFloat(c4d.TSOUND_THRESHOLD,0.1)
    bc.SetBool(c4d.TSOUND_SPEED,True)
    bc.SetInt32(c4d.TSOUND_SPMULT,1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../res/description/txsound.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Osphere);
    pDoc->InsertObject(pObject);
    pDoc->StartUndo();
    pDoc->AddUndo(UNDOTYPE_NEW,pObject);
    pDoc->EndUndo();
    pDoc->StartUndo();
    BaseTag *pTag = pObject->MakeTag(Txsound);
    pDoc->AddUndo(UNDOTYPE_NEW,pTag);
    pDoc->EndUndo();
    pObject->Message(MSG_UPDATE);
    
    //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;
    pTag->SetParameter(DescID(TSOUND_WAVFILE),GeData(Filename("c:\\SomeFile.txt"),flags);
    pTag->SetParameter(DescID(TSOUND_ENABLED),GeData(true),flags);
    pTag->SetParameter(DescID(TSOUND_MULTIPLIER),GeData(1),flags);
    pTag->SetParameter(DescID(TSOUND_THRESHOLD),GeData(0.1),flags);
    pTag->SetParameter(DescID(TSOUND_SPEED),GeData(true),flags);
    pTag->SetParameter(DescID(TSOUND_SPMULT),GeData(1),flags);
    pTag->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pTag->GetDataInstance();
    bc->SetFileName(TSOUND_WAVFILE,"c:\\SomeFile.txt");
    bc->SetBool(TSOUND_ENABLED,true);
    bc->SetInt32(TSOUND_MULTIPLIER,1);
    bc->SetFloat(TSOUND_THRESHOLD,0.1);
    bc->SetBool(TSOUND_SPEED,true);
    bc->SetInt32(TSOUND_SPMULT,1);
    pTag->Message(MSG_UPDATE);                                                      
}
             

Buttons

This node has buttons. Buttons can manually be executed by calling the following code

Python

c4d.CallButton(tag,c4d.TSO_HELP_BUTTON)
c4d.CallButton(tag,c4d.TSO_VIDMAN_BUTTON)
c4d.CallButton(tag,c4d.TSOUND_RESET)
c4d.CallButton(tag,c4d.TSOUND_SAVE_PRESET)
c4d.CallButton(tag,c4d.TSOUND_LOAD_PRESET)

C++

DescriptionCommand dc;
dc.id = DescID(TSO_HELP_BUTTON);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);


DescriptionCommand dc;
dc.id = DescID(TSO_VIDMAN_BUTTON);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);


DescriptionCommand dc;
dc.id = DescID(TSOUND_RESET);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);


DescriptionCommand dc;
dc.id = DescID(TSOUND_SAVE_PRESET);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);


DescriptionCommand dc;
dc.id = DescID(TSOUND_LOAD_PRESET);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);