MeiCam SDK For iOS  3.14.0
NvsFx.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: Dec 29. 2016
11 // Author: Meishe video team
12 //================================================================================
13 
16 #pragma once
17 
18 #import "NvsObject.h"
19 #import "NvsCommonDef.h"
20 
27 typedef enum {
31 
38 typedef enum {
42 
49 typedef enum {
52 
53 @class NvsArbitraryData;
54 @class NvsFxDescription;
56 @class NvsARFaceContext;
59 @class NvsMaskRegionInfo;
60 @class NvsControlPointPair;
62 @class NvsMeshWarpInfo;
65 
83 
84 @property (readonly) NvsFxDescription *description;
85 
97 - (void)setIntVal:(NSString *)fxParam val:(int)val;
98 
110 - (int)getIntVal:(NSString *)fxParam;
111 
125 - (void)setIntValAtTime:(NSString *)fxParam val:(int)val time:(int64_t)time;
126 
140 - (int)getIntValAtTime:(NSString *)fxParam time:(int64_t)time;
141 
153 - (void)setFloatVal:(NSString *)fxParam val:(double)val;
154 
166 - (double)getFloatVal:(NSString *)fxParam;
167 
181 - (void)setFloatValAtTime:(NSString *)fxParam val:(double)val time:(int64_t)time;
182 
196 - (double)getFloatValAtTime:(NSString *)fxParam time:(int64_t)time;
197 
209 - (void)setBooleanVal:(NSString *)fxParam val:(BOOL)val;
210 
222 - (BOOL)getBooleanVal:(NSString *)fxParam;
223 
237 - (void)setBooleanValAtTime:(NSString *)fxParam val:(BOOL)val time:(int64_t)time;
238 
252 - (BOOL)getBooleanValAtTime:(NSString *)fxParam time:(int64_t)time;
253 
265 - (void)setStringVal:(NSString *)fxParam val:(NSString *)val;
266 
278 - (NSString *)getStringVal:(NSString *)fxParam;
279 
293 - (void)setStringValAtTime:(NSString *)fxParam val:(NSString *)val time:(int64_t)time;
294 
308 - (NSString *)getStringValAtTime:(NSString *)fxParam time:(int64_t)time;
309 
321 - (void)setColorVal:(NSString *)fxParam val:(NvsColor *)val;
322 
334 - (NvsColor)getColorVal:(NSString *)fxParam;
335 
349 - (void)setColorValAtTime:(NSString *)fxParam val:(NvsColor *)val time:(int64_t)time;
350 
364 - (NvsColor)getColorValAtTime:(NSString *)fxParam time:(int64_t)time;
365 
378 - (void)setPosition2DVal:(NSString *)fxParam val:(NvsPosition2D *)val;
379 
392 - (NvsPosition2D)getPosition2DVal:(NSString *)fxParam;
393 
408 - (void)setPosition2DValAtTime:(NSString *)fxParam val:(NvsPosition2D *)val time:(int64_t)time;
409 
424 - (NvsPosition2D)getPosition2DValAtTime:(NSString *)fxParam time:(int64_t)time;
425 
438 - (void)setPosition3DVal:(NSString *)fxParam val:(NvsPosition3D *)val;
439 
452 - (NvsPosition3D)getPosition3DVal:(NSString *)fxParam;
453 
468 - (void)setPosition3DValAtTime:(NSString *)fxParam val:(NvsPosition3D *)val time:(int64_t)time;
469 
484 - (NvsPosition3D)getPosition3DValAtTime:(NSString *)fxParam time:(int64_t)time;
485 
497 - (void)setMenuVal:(NSString *)fxParam val:(NSString *)val;
498 
510 - (NSString *)getMenuVal:(NSString *)fxParam;
511 
525 - (void)setMenuValAtTime:(NSString *)fxParam val:(NSString *)val time:(int64_t)time;
526 
540 - (NSString *)getMenuValAtTime:(NSString *)fxParam time:(int64_t)time;
541 
553 - (void)setArbDataVal:(NSString *)fxParam val:(NvsArbitraryData *)val;
554 
566 - (NvsArbitraryData *)getArbDataVal:(NSString *)fxParam;
567 
581 - (void)setArbDataValAtTime:(NSString *)fxParam val:(NvsArbitraryData *)val time:(int64_t)time;
582 
596 - (NvsArbitraryData *)getArbDataValAtTime:(NSString *)fxParam time:(int64_t)time;
597 
610 - (bool)removeKeyframeAtTime:(NSString *)fxParam time:(int64_t)time;
611 
622 - (bool)removeAllKeyframe:(NSString *)fxParam;
623 
634 - (bool)hasKeyframeList:(NSString *)fxParam;
635 
650 - (int64_t)findKeyframeTime:(NSString *)fxParam time:(int64_t)time flags:(int)flags;
651 
666 - (bool)setKeyFrameControlPoint:(NSString *)fxParam time:(int64_t)time controlPointPair:(NvsControlPointPair *)controlPointPair;
667 
682 - (NvsControlPointPair*)getKeyFrameControlPoint:(NSString *)fxParam time:(int64_t)time;
683 
698 - (bool)setKeyFrameControlPointMode:(NSString *)fxParam time:(int64_t)time controlPointModePair:(NvsControlPointModePair *)controlPointModePair;
699 
714 - (NvsControlPointModePair*)getKeyFrameControlPointMode:(NSString *)fxParam time:(int64_t)time;
715 
726 -(void)setFilterIntensity:(float)intensity;
727 
738 -(float)getFilterIntensity;
739 
750 -(void)setFilterMask:(bool)useMask;
751 
762 -(bool)getFilterMask;
763 
774 -(void)setRegional:(BOOL)isRegional;
775 
786 -(BOOL)getRegional;
787 
798 -(void)setIgnoreBackground:(BOOL)isIgnoreBackground;
799 
810 -(BOOL)getIgnoreBackground;
811 
812 
823 -(void)setInverseRegion:(BOOL)isInverseRegion;
824 
835 -(BOOL)getInverseRegion;
836 
847 -(NSArray *)getRegion;
848 
859 -(void)setRegion:(NSArray *)region;
860 
872 
883 -(void)setRegionInfo:(NvsMaskRegionInfo *)info;
884 
897 -(void)setRegionInfoAtTime:(NvsMaskRegionInfo *)info time:(int64_t)time;
898 
909 -(NvsMaskRegionInfo *)getRegionInfoAtTime:(int64_t)time;
910 
921 -(void)setRegionalFeatherWidth:(float)featherWidth;
922 
934 
947 - (void)setRegionalFeatherWidthAtTime:(float)featherWidth time:(int64_t)time;
948 
961 - (float)getRegionalFeatherWidthAtTime:(int64_t)time;
962 
973 -(void)setRegionCoordinateSystemType:(int)type;
974 
986 
996 
1006 
1017 
1027 
1040 - (void)setExprVar:(NSString *)varName varValue:(double)varValue;
1041 
1054 - (double)getExprVar:(NSString *)varName;
1055 
1068 - (void)setColorExprVar:(NSString *)varName varValue:(NvsColor *)color;
1069 
1082 - (NvsColor)getColorExprVar:(NSString *)varName;
1083 
1093 - (void)clearExprVar:(NSString *)varName;
1094 
1102 - (void)clearExprVarCtx;
1103 @end
-[NvsFx getFilterMask]
bool getFilterMask()
Get the usage of the filter's mask.
NvsARSceneManipulate
AR scene processing interface.
Definition: NvsARSceneManipulate.h:290
NvsRegionCoordinateSystemType_Timeline
@ NvsRegionCoordinateSystemType_Timeline
timeline coordinate system
Definition: NvsFx.h:40
NvsKeyFrameFindModeFlag
NvsKeyFrameFindModeFlag
Key frame find mode.
Definition: NvsFx.h:27
-[NvsFx getPaintingEffectContext]
NvsPaintingEffectContext * getPaintingEffectContext()
Get the particle effect context pointer.Please refer to NvsPaintingEffectContext.
NvsControlPointPair
Key frame control point pair structure.
Definition: NvsControlPointPair.h:27
-[NvsFx getARFaceContext]
NvsARFaceContext * getARFaceContext()
Get face effect context pointer.Please refer to NvsARFaceContext.
-[NvsFx getRegionCoordinateSystemType]
int getRegionCoordinateSystemType()
Get the coordinate system of the region.
-[NvsFx getParticleSystemContext]
NvsParticleSystemContext * getParticleSystemContext()
Get the particle effect context pointer.Please refer to NvsParticleSystemContext.
-[NvsFx getRegionInfo]
NvsMaskRegionInfo * getRegionInfo()
Get the mask region informations of the regional filter.
-[NvsFx getRegionalFeatherWidth]
float getRegionalFeatherWidth()
Get the feather width of the regional filter.
NvsObject
The NvsObject class inherits from the NSObject class in object-c.
Definition: NvsObject.h:78
NvsKeyFrameFindModeFlag_After
@ NvsKeyFrameFindModeFlag_After
find key frame after current time
Definition: NvsFx.h:29
NvsFxDescription
Effect parameter description class.
Definition: NvsFxDescription.h:33
NvsPosition3D
3D coordinate structure
Definition: NvsCommonDef.h:423
-[NvsFx getIgnoreBackground]
BOOL getIgnoreBackground()
Get whether the regional filter ignores background.
NvsFx
effect class.
Definition: NvsFx.h:83
NvsMaskRegionInfo
Mask Region information.
Definition: NvsMaskRegionInfo.h:98
-[NvsFx getARSceneManipulate]
NvsARSceneManipulate * getARSceneManipulate()
Get the AR scene operation pointer.Please refer to NvsARSceneManipulate.
NvsFaceWarpEffectStrategy_Custom
@ NvsFaceWarpEffectStrategy_Custom
Face warp effect custom strategy.
Definition: NvsFx.h:50
-[NvsFx clearExprVarCtx]
void clearExprVarCtx()
Clear all parameter values defined in the expression and set them to the default value of 0.
-[NvsFx getRegional]
BOOL getRegional()
Get whether the filter is regional.
NvsColor
Self-defined color.
Definition: NvsCommonDef.h:403
NvsObject.h
NvsPaintingEffectContext
Painting special effects context.
Definition: NvsPaintingEffectContext.h:71
NvsFx::description
NvsFxDescription * description
Special effect description.
Definition: NvsFx.h:84
NvsRegionCoordinateSystemType
NvsRegionCoordinateSystemType
Region Coordinate System Type.
Definition: NvsFx.h:38
NvsRegionCoordinateSystemType_NDC
@ NvsRegionCoordinateSystemType_NDC
NDC coordinate system.
Definition: NvsFx.h:39
-[NvsFx getRegion]
NSArray * getRegion()
Get the region of this regional filter.
NvsStoryboard3DSceneAnimData
Definition: NvsStoryboard3DSceneAnimData.h:34
NVS_EXPORT
#define NVS_EXPORT
Definition: NvsCommonDef.h:20
NvsStoryboard3DMorphingData
Definition: NvsStoryboard3DMorphingData.h:46
NvsParticleSystemContext
Particle effect context The particle system is composed of several particle emitters and sub-emitters...
Definition: NvsParticleSystemContext.h:30
NvsCommonDef.h
NvsKeyFrameFindModeFlag_Before
@ NvsKeyFrameFindModeFlag_Before
find key frame before current time
Definition: NvsFx.h:28
-[NvsFx getFilterIntensity]
float getFilterIntensity()
Get the intensity of the filter.
NvsFaceWarpEffectStrategy
NvsFaceWarpEffectStrategy
Definition: NvsFx.h:49
NvsARFaceContext
ARFace context.
Definition: NvsARFaceContext.h:158
NvsPosition2D
2D coordinate structure
Definition: NvsCommonDef.h:413
NvsMeshWarpInfo
Mask Region information.
Definition: NvsMeshWarpInfo.h:54
NvsArbitraryData
A custom parameter structure for video effects.
Definition: NvsArbitraryData.h:29
NvsControlPointModePair
Key frame control point mode pair structure.
Definition: NvsControlPointModePair.h:27
-[NvsFx getInverseRegion]
BOOL getInverseRegion()
Get whether the regional filter inverses region.