IDs and information for HighLights

HighLights

Attributes

• ENGLISH NAME : Highlights
• NAME : HLIGHT_NAME
• INCLUDE : VPbase
• PATH : advanced_render/description/highlights.res
• PLUGIN : advanced_render
• MAXON online help (may not exist): HIGHLIGHTS

Elements

ID	UI Name	Type	Parameters	Cycle
HLIGHT_FACEINTENS	Threshold	REAL	UNIT PERCENT MIN 0.0
HLIGHT_MININTENS	MinimumFlareIntensity	REAL	UNIT PERCENT MIN 0.0
HLIGHT_MAXINTENS	MaximumFlareIntensity	REAL	UNIT PERCENT MIN 0.0
HLIGHT_SIZE	FlareSize	REAL	UNIT PERCENT MIN 0.0 MAX 1000.0
HLIGHT_PRESET	Preset	LONG		HLIGHT_PRESET_CUSTOM Custom HLIGHT_PRESET_1 FineRegular HLIGHT_PRESET_2 FineRandom HLIGHT_PRESET_3 Wideangle HLIGHT_PRESET_4 Zoom HLIGHT_PRESET_5 Camcorder HLIGHT_PRESET_6 Searchlight HLIGHT_PRESET_7 Streaks1 HLIGHT_PRESET_8 Streaks2 HLIGHT_PRESET_9 Star1 HLIGHT_PRESET_10 Star2 HLIGHT_PRESET_11 Flashlight HLIGHT_PRESET_12 Sun HLIGHT_PRESET_13 BrokenStar HLIGHT_PRESET_14 FineYellowStar HLIGHT_PRESET_15 SoftStreaks1 HLIGHT_PRESET_16 SoftStreaks2 HLIGHT_PRESET_17 Blue
HLIGHT_LENSGLOW	Highlight	LENSGLOW	PREVIEW
HLIGHT_USE_OBJID	UseObjectID	BOOL
HLIGHT_OBJID	ObjectID	LONG	PARENTID HLIGHT_USE_OBJID MIN 1

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():
    videoPost = c4d.BaseVideoPost(c4d.HighLights)
    
    #You can set parameters two different ways. 
    #First way              
    videoPost[c4d.HLIGHT_FACEINTENS] = 0.1
    videoPost[c4d.HLIGHT_MININTENS] = 0.1
    videoPost[c4d.HLIGHT_MAXINTENS] = 0.1
    videoPost[c4d.HLIGHT_SIZE] = 0.1
    videoPost[c4d.HLIGHT_PRESET] = c4d.HLIGHT_PRESET_CUSTOM
    videoPost[c4d.HLIGHT_USE_OBJID] = True
    videoPost[c4d.HLIGHT_OBJID] = 1
    
    #Second way, using the base container.
    bc = videoPost.GetDataInstance()
    bc.SetFloat(c4d.HLIGHT_FACEINTENS,0.1)
    bc.SetFloat(c4d.HLIGHT_MININTENS,0.1)
    bc.SetFloat(c4d.HLIGHT_MAXINTENS,0.1)
    bc.SetFloat(c4d.HLIGHT_SIZE,0.1)
    bc.SetInt32(c4d.HLIGHT_PRESET,c4d.HLIGHT_PRESET_CUSTOM)
    bc.SetBool(c4d.HLIGHT_USE_OBJID,True)
    bc.SetInt32(c4d.HLIGHT_OBJID,1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../advanced_render/description/highlights.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseVideoPost *pVideoPost = BaseVideoPost::Alloc(HighLights);  
    
    //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;
    pVideoPost->SetParameter(DescID(HLIGHT_FACEINTENS),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(HLIGHT_MININTENS),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(HLIGHT_MAXINTENS),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(HLIGHT_SIZE),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(HLIGHT_PRESET),GeData(HLIGHT_PRESET_CUSTOM),flags);
    pVideoPost->SetParameter(DescID(HLIGHT_USE_OBJID),GeData(true),flags);
    pVideoPost->SetParameter(DescID(HLIGHT_OBJID),GeData(1),flags);
    pVideoPost->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pVideoPost->GetDataInstance();
    bc->SetFloat(HLIGHT_FACEINTENS,0.1);
    bc->SetFloat(HLIGHT_MININTENS,0.1);
    bc->SetFloat(HLIGHT_MAXINTENS,0.1);
    bc->SetFloat(HLIGHT_SIZE,0.1);
    bc->SetInt32(HLIGHT_PRESET,HLIGHT_PRESET_CUSTOM);
    bc->SetBool(HLIGHT_USE_OBJID,true);
    bc->SetInt32(HLIGHT_OBJID,1);
    pVideoPost->Message(MSG_UPDATE);                                                      
}