MeiCam SDK For iOS  3.15.0
NvsEffect.h
Go to the documentation of this file.
1 //================================================================================
2 //
3 // (c) Copyright Meishe Co. Ltd, 2016. All rights reserved.
4 //
5 // This code and information is provided "as is" without warranty of any kind,
6 // either expressed or implied, including but not limited to the implied
7 // warranties of merchantability and/or fitness for a particular purpose.
8 //
9 //--------------------------------------------------------------------------------
10 // Birth Date: Sep 7. 2019
11 // Author: Meishe video team
12 //================================================================================
13 
14 #pragma once
15 
16 #import <Foundation/Foundation.h>
17 #import "NvsEffectCommonDef.h"
18 
19 @class NvsArbitraryData;
24 @class NvsMaskRegionInfo;
25 @class NvsControlPointPair;
27 @class NvsMeshWarpInfo;
30 
45 NVS_EXPORT @interface NvsEffect : NSObject
46 
47 @property (readonly) NvsEffectDescription *description;
48 
60 - (void)setIntVal:(NSString *)fxParam val:(int)val;
61 
73 - (int)getIntVal:(NSString *)fxParam;
74 
88 - (void)setIntValAtTime:(NSString *)fxParam val:(int)val time:(int64_t)time;
89 
103 - (int)getIntValAtTime:(NSString *)fxParam time:(int64_t)time;
104 
116 - (void)setFloatVal:(NSString *)fxParam val:(double)val;
117 
129 - (double)getFloatVal:(NSString *)fxParam;
130 
144 - (void)setFloatValAtTime:(NSString *)fxParam val:(double)val time:(int64_t)time;
145 
159 - (double)getFloatValAtTime:(NSString *)fxParam time:(int64_t)time;
160 
172 - (void)setBooleanVal:(NSString *)fxParam val:(BOOL)val;
173 
185 - (BOOL)getBooleanVal:(NSString *)fxParam;
186 
200 - (void)setBooleanValAtTime:(NSString *)fxParam val:(BOOL)val time:(int64_t)time;
201 
215 - (BOOL)getBooleanValAtTime:(NSString *)fxParam time:(int64_t)time;
216 
228 - (void)setStringVal:(NSString *)fxParam val:(NSString *)val;
229 
243 - (void)setStringVal:(NSString *)fxParam val:(NSString *)val time:(int64_t)time;
244 
256 - (NSString *)getStringVal:(NSString *)fxParam;
257 
271 - (NSString *)getStringVal:(NSString *)fxParam time:(int64_t)time;
272 
284 - (void)setColorVal:(NSString *)fxParam val:(NvsEffectColor *)val;
285 
297 - (NvsEffectColor)getColorVal:(NSString *)fxParam;
298 
312 - (void)setColorValAtTime:(NSString *)fxParam val:(NvsEffectColor *)val time:(int64_t)time;
313 
327 - (NvsEffectColor)getColorValAtTime:(NSString *)fxParam time:(int64_t)time;
328 
340 - (void)setPosition2DVal:(NSString *)fxParam val:(NvsEffectPosition2D *)val;
341 
353 - (NvsEffectPosition2D)getPosition2DVal:(NSString *)fxParam;
354 
369 - (void)setPosition2DValAtTime:(NSString *)fxParam val:(NvsEffectPosition2D *)val time:(int64_t)time;
370 
385 - (NvsEffectPosition2D)getPosition2DValAtTime:(NSString *)fxParam time:(int64_t)time;
386 
398 - (void)setPosition3DVal:(NSString *)fxParam val:(NvsEffectPosition3D *)val;
399 
411 - (NvsEffectPosition3D)getPosition3DVal:(NSString *)fxParam;
412 
427 - (void)setPosition3DValAtTime:(NSString *)fxParam val:(NvsEffectPosition3D *)val time:(int64_t)time;
428 
443 - (NvsEffectPosition3D)getPosition3DValAtTime:(NSString *)fxParam time:(int64_t)time;
444 
456 - (void)setMenuVal:(NSString *)fxParam val:(NSString *)val;
457 
469 - (NSString *)getMenuVal:(NSString *)fxParam;
470 
484 - (void)setMenuValAtTime:(NSString *)fxParam val:(NSString *)val time:(int64_t)time;
485 
499 - (NSString *)getMenuValAtTime:(NSString *)fxParam time:(int64_t)time;
500 
511 - (void)setArbDataVal:(NSString *)fxParam val:(NvsArbitraryData *)val;
512 
524 - (NvsArbitraryData *)getArbDataVal:(NSString *)fxParam;
525 
539 - (void)setArbDataValAtTime:(NSString *)fxParam val:(NvsArbitraryData *)val time:(int64_t)time;
540 
554 - (NvsArbitraryData *)getArbDataValAtTime:(NSString *)fxParam time:(int64_t)time;
555 
568 - (bool)removeKeyframeAtTime:(NSString *)fxParam time:(int64_t)time;
569 
580 - (bool)removeAllKeyframe:(NSString *)fxParam;
581 
592 - (bool)hasKeyframeList:(NSString *)fxParam;
593 
608 - (int64_t)findKeyframeTime:(NSString *)fxParam time:(int64_t)time flags:(int)flags;
609 
624 - (bool)setKeyFrameControlPoint:(NSString *)fxParam time:(int64_t)time controlPointPair:(NvsControlPointPair *)controlPointPair;
625 
640 - (NvsControlPointPair*)getKeyFrameControlPoint:(NSString *)fxParam time:(int64_t)time;
641 
656 - (bool)setKeyFrameControlPointMode:(NSString *)fxParam time:(int64_t)time controlPointModePair:(NvsControlPointModePair *)controlPointModePair;
657 
672 - (NvsControlPointModePair*)getKeyFrameControlPointMode:(NSString *)fxParam time:(int64_t)time;
673 
684 -(void)setFilterIntensity:(float)intensity;
685 
696 -(float)getFilterIntensity;
697 
708 -(void)setFilterMask:(bool)useMask;
709 
720 -(bool)getFilterMask;
721 
732 -(void)setRegional:(BOOL)isRegional;
733 
744 -(BOOL)getRegional;
745 
756 -(void)setIgnoreBackground:(BOOL)isIgnoreBackground;
757 
768 -(BOOL)getIgnoreBackground;
769 
780 -(void)setInverseRegion:(BOOL)isInverseRegion;
781 
792 -(BOOL)getInverseRegion;
793 
803 -(void)setRegion:(NSArray *)region;
804 
815 -(NSArray *)getRegion;
816 
827 
837 -(void)setRegionInfo:(NvsMaskRegionInfo *)info;
838 
848 -(void)setRegionInfoAtTime:(NvsMaskRegionInfo *)info time:(int64_t)time;
849 
860 -(void)setRegionalFeatherWidth:(float)featherWidth;
861 
873 
884 -(void)setRegionCoordinateSystemType:(int)type;
885 
897 
907 
917 
927 
939 - (void)setExprVar:(NSString *)varName varValue:(double)varValue;
940 
952 - (double)getExprVar:(NSString *)varName;
953 
963 - (void)clearExprVar:(NSString *)varName;
964 
974 - (void)clearExprVarCtx;
975 
983 - (void)resetEffectContext;
984 
985 @end
NvsEffectDescription
Effect parameter description class in effect sdk.
Definition: NvsEffectDescription.h:184
NvsARSceneManipulate
AR scene processing interface.
Definition: NvsARSceneManipulate.h:290
NvsControlPointPair
Key frame control point pair structure.
Definition: NvsControlPointPair.h:27
-[NvsEffect getPaintingEffectContext]
NvsPaintingEffectContext * getPaintingEffectContext()
Gets the particle effect context.
-[NvsEffect getParticleSystemContext]
NvsParticleSystemContext * getParticleSystemContext()
Gets the particle effect context.
-[NvsEffect getIgnoreBackground]
BOOL getIgnoreBackground()
Gets whether the regional filter ignores Background.
NvsMaskRegionInfo
Mask Region information.
Definition: NvsMaskRegionInfo.h:98
-[NvsEffect getRegion]
NSArray * getRegion()
Get the region of this regional filter.
-[NvsEffect getFilterMask]
bool getFilterMask()
Gets the usage of the filter's mask.
NvsEffectPosition3D
3D coordinate structure
Definition: NvsEffectCommonDef.h:75
-[NvsEffect getRegionalFeatherWidth]
float getRegionalFeatherWidth()
Gets the feather width of this regional filter.
NvsEffect::description
NvsEffectDescription * description
Definition: NvsEffect.h:47
-[NvsEffect getRegionInfo]
NvsMaskRegionInfo * getRegionInfo()
Get the region of this regional filter.
NvsPaintingEffectContext
Painting special effects context.
Definition: NvsPaintingEffectContext.h:71
-[NvsEffect getInverseRegion]
BOOL getInverseRegion()
Gets whether the regional filter inverse region.
NvsEffectColor
Self-defined color.
Definition: NvsEffectCommonDef.h:55
-[NvsEffect getFilterIntensity]
float getFilterIntensity()
Gets the filter intensity.
NvsStoryboard3DSceneAnimData
Definition: NvsStoryboard3DSceneAnimData.h:34
NVS_EXPORT
#define NVS_EXPORT
Definition: NvsCommonDef.h:20
NvsEffect
Special effects.
Definition: NvsEffect.h:46
NvsStoryboard3DMorphingData
Definition: NvsStoryboard3DMorphingData.h:46
-[NvsEffect clearExprVarCtx]
void clearExprVarCtx()
Clears the value of all parameters defined in the expression and sets it to the default value of 0.
-[NvsEffect getRegionCoordinateSystemType]
int getRegionCoordinateSystemType()
Gets the coordinate system of the region.
-[NvsEffect resetEffectContext]
void resetEffectContext()
Reset the internal data of effectcontext.
NvsParticleSystemContext
Particle effect context The particle system is composed of several particle emitters and sub-emitters...
Definition: NvsParticleSystemContext.h:30
NvsEffectCommonDef.h
NvsMeshWarpInfo
Mask Region information.
Definition: NvsMeshWarpInfo.h:54
NvsArbitraryData
A custom parameter structure for video effects.
Definition: NvsArbitraryData.h:29
-[NvsEffect getARSceneManipulate]
NvsARSceneManipulate * getARSceneManipulate()
Get the AR scene operation pointer.
NvsControlPointModePair
Key frame control point mode pair structure.
Definition: NvsControlPointModePair.h:27
-[NvsEffect getRegional]
BOOL getRegional()
Gets whether the filter is regional.
NvsEffectPosition2D
2D coordinate structure
Definition: NvsEffectCommonDef.h:65