IDs and information for pvfilter

pvfilter

Attributes

• ENGLISH NAME :
• NAME : pvfilter
• INCLUDE : VPbase
• PATH : newman/description/pvfilter.res
• PLUGIN : newman
• MAXON online help (may not exist): PVFILTER

Elements

ID	UI Name	Type	Parameters	Cycle
ID_PV_FILTER_TONEMAPPING	ToneMapping	REAL	UNIT PERCENT MIN 0.0 MAXSLIDER 100.0 CUSTOMGUI REALSLIDER
ID_PV_FILTER_SATURATION	Saturation	REAL	UNIT PERCENT MIN -100.0 MAX 100.0 CUSTOMGUI REALSLIDER
ID_PV_FILTER_BRIGHTNESS	Brightness	REAL	UNIT PERCENT MIN -100.0 MAX 100.0 CUSTOMGUI REALSLIDER
ID_PV_FILTER_CONTRAST	Contrast	REAL	UNIT PERCENT MIN -100.0 MAX 100.0 CUSTOMGUI REALSLIDER
ID_PV_FILTER_EXPOSURE	Exposure	REAL	STEP 0.01 MIN -10.0 MAX 10.0 CUSTOMGUI REALSLIDER
ID_PV_FILTER_GAMMA	Gamma	REAL	STEP 0.01 MIN 0.1 MAX 10.0 CUSTOMGUI REALSLIDER
ID_PV_FILTER_RED	Red	BOOL
ID_PV_FILTER_GREEN	Green	BOOL
ID_PV_FILTER_BLUE	Blue	BOOL
ID_PV_FILTER_INVERT	Invert	BOOL
ID_PV_FILTER_BLACKPOINT	BlackPoint	REAL	STEP 0.01 MIN 0.0 MAX 100.0 MINSLIDER 0.0 MAXSLIDER 1.0
ID_PV_FILTER_WHITEPOINT	WhitePoint	REAL	STEP 0.01 MIN 0.0 MAX 100.0 MINSLIDER 0.0 MAXSLIDER 1.0
ID_PV_FILTER_GRAD_INTENSITY	GradingIntensity	REAL	UNIT PERCENT MIN 0.0 MAX 100.0 CUSTOMGUI REALSLIDER
ID_PV_FILTER_GRAD_MIN	CurveMin	REAL	UNIT REAL STEP 0.1
ID_PV_FILTER_GRAD_MAX	CurveMax	REAL	UNIT REAL STEP 0.1
ID_PV_FILTER_GRAD_SPLINE_RGB	Curve	SPLINE	SHOWGRID_H SHOWGRID_V EDIT_H EDIT_V X_MIN 0 X_MAX 1 Y_MIN 0 Y_MAX 1 X_STEPS 0.01 Y_STEPS 0.01
ID_PV_FILTER_GRAD_SPLINE_R	Red	SPLINE	SHOWGRID_H SHOWGRID_V EDIT_H EDIT_V X_MIN 0 X_MAX 1 Y_MIN 0 Y_MAX 1 X_STEPS 0.01 Y_STEPS 0.01 CUSTOMCOLOR_SET CUSTOMCOLOR_COL 1.0
ID_PV_FILTER_GRAD_SPLINE_G	Green	SPLINE	SHOWGRID_H SHOWGRID_V EDIT_H EDIT_V X_MIN 0 X_MAX 1 Y_MIN 0 Y_MAX 1 X_STEPS 0.01 Y_STEPS 0.01 CUSTOMCOLOR_SET CUSTOMCOLOR_COL 0.0
ID_PV_FILTER_GRAD_SPLINE_B	Blue	SPLINE	SHOWGRID_H SHOWGRID_V EDIT_H EDIT_V X_MIN 0 X_MAX 1 Y_MIN 0 Y_MAX 1 X_STEPS 0.01 Y_STEPS 0.01 CUSTOMCOLOR_SET CUSTOMCOLOR_COL 0.0
ID_PV_FILTER_RESET	ResetValues	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():
    videoPost = c4d.BaseVideoPost(c4d.pvfilter)
    
    #You can set parameters two different ways. 
    #First way              
    videoPost[c4d.ID_PV_FILTER_TONEMAPPING] = 0.1
    videoPost[c4d.ID_PV_FILTER_SATURATION] = 0.1
    videoPost[c4d.ID_PV_FILTER_BRIGHTNESS] = 0.1
    videoPost[c4d.ID_PV_FILTER_CONTRAST] = 0.1
    videoPost[c4d.ID_PV_FILTER_EXPOSURE] = 0.1
    videoPost[c4d.ID_PV_FILTER_GAMMA] = 0.1
    videoPost[c4d.ID_PV_FILTER_RED] = True
    videoPost[c4d.ID_PV_FILTER_GREEN] = True
    videoPost[c4d.ID_PV_FILTER_BLUE] = True
    videoPost[c4d.ID_PV_FILTER_INVERT] = True
    videoPost[c4d.ID_PV_FILTER_BLACKPOINT] = 0.1
    videoPost[c4d.ID_PV_FILTER_WHITEPOINT] = 0.1
    videoPost[c4d.ID_PV_FILTER_GRAD_INTENSITY] = 0.1
    videoPost[c4d.ID_PV_FILTER_GRAD_MIN] = 0.1
    videoPost[c4d.ID_PV_FILTER_GRAD_MAX] = 0.1
    
    #Second way, using the base container.
    bc = videoPost.GetDataInstance()
    bc.SetFloat(c4d.ID_PV_FILTER_TONEMAPPING,0.1)
    bc.SetFloat(c4d.ID_PV_FILTER_SATURATION,0.1)
    bc.SetFloat(c4d.ID_PV_FILTER_BRIGHTNESS,0.1)
    bc.SetFloat(c4d.ID_PV_FILTER_CONTRAST,0.1)
    bc.SetFloat(c4d.ID_PV_FILTER_EXPOSURE,0.1)
    bc.SetFloat(c4d.ID_PV_FILTER_GAMMA,0.1)
    bc.SetBool(c4d.ID_PV_FILTER_RED,True)
    bc.SetBool(c4d.ID_PV_FILTER_GREEN,True)
    bc.SetBool(c4d.ID_PV_FILTER_BLUE,True)
    bc.SetBool(c4d.ID_PV_FILTER_INVERT,True)
    bc.SetFloat(c4d.ID_PV_FILTER_BLACKPOINT,0.1)
    bc.SetFloat(c4d.ID_PV_FILTER_WHITEPOINT,0.1)
    bc.SetFloat(c4d.ID_PV_FILTER_GRAD_INTENSITY,0.1)
    bc.SetFloat(c4d.ID_PV_FILTER_GRAD_MIN,0.1)
    bc.SetFloat(c4d.ID_PV_FILTER_GRAD_MAX,0.1)

if __name__=='__main__':
    main()
             

C++

#include "c4d.h"
#include "../newman/description/pvfilter.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseVideoPost *pVideoPost = BaseVideoPost::Alloc(pvfilter);  
    
    //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(ID_PV_FILTER_TONEMAPPING),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_SATURATION),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_BRIGHTNESS),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_CONTRAST),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_EXPOSURE),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_GAMMA),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_RED),GeData(true),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_GREEN),GeData(true),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_BLUE),GeData(true),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_INVERT),GeData(true),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_BLACKPOINT),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_WHITEPOINT),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_GRAD_INTENSITY),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_GRAD_MIN),GeData(0.1),flags);
    pVideoPost->SetParameter(DescID(ID_PV_FILTER_GRAD_MAX),GeData(0.1),flags);
    pVideoPost->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pVideoPost->GetDataInstance();
    bc->SetFloat(ID_PV_FILTER_TONEMAPPING,0.1);
    bc->SetFloat(ID_PV_FILTER_SATURATION,0.1);
    bc->SetFloat(ID_PV_FILTER_BRIGHTNESS,0.1);
    bc->SetFloat(ID_PV_FILTER_CONTRAST,0.1);
    bc->SetFloat(ID_PV_FILTER_EXPOSURE,0.1);
    bc->SetFloat(ID_PV_FILTER_GAMMA,0.1);
    bc->SetBool(ID_PV_FILTER_RED,true);
    bc->SetBool(ID_PV_FILTER_GREEN,true);
    bc->SetBool(ID_PV_FILTER_BLUE,true);
    bc->SetBool(ID_PV_FILTER_INVERT,true);
    bc->SetFloat(ID_PV_FILTER_BLACKPOINT,0.1);
    bc->SetFloat(ID_PV_FILTER_WHITEPOINT,0.1);
    bc->SetFloat(ID_PV_FILTER_GRAD_INTENSITY,0.1);
    bc->SetFloat(ID_PV_FILTER_GRAD_MIN,0.1);
    bc->SetFloat(ID_PV_FILTER_GRAD_MAX,0.1);
    pVideoPost->Message(MSG_UPDATE);                                                      
}
             

Buttons

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

Python

c4d.CallButton(videoPost,c4d.ID_PV_FILTER_RESET)

C++

DescriptionCommand dc;
dc.id = DescID(ID_PV_FILTER_RESET);             
pVideoPost->Message(MSG_DESCRIPTION_COMMAND, &dc);