CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriLipsDeformerForAtomSource Class Reference

Component that operates ICriLipsMorph in conjunction with CriAtomSource. More...

Inheritance diagram for CriLipsDeformerForAtomSource:
CriLipsDeformer

Public Types

enum  UpdateScheduleType { LateUpdate = 0, Update, Manual }
 Timing for reflecting the analysis results More...
 

Public Member Functions

bool AttachToAtomSource (CriAtomSourceBase source)
 Attaches to the AtomSource to be analyzed More...
 
override void CriInternalUpdate ()
 
delegate void UserModifyDelegateFunction (ref CriLipsMouth.Info info, ref CriLipsMouth.MorphTargetBlendAmountAsJapanese morph, ICriLipsAnalyzeModule analyzeModule)
 Definition of the delegate used to modify the analysis result
 
void ManualUpdate ()
 Updating ICriLipsMorph (manual operation) More...
 

Public Attributes

UserModifyDelegateFunction UserModifyDelegate = null
 Delegate for change in analysis result
 
UpdateScheduleType UpdateSchedule
 Setting the timing at which the analysis results are reflected More...
 

Protected Member Functions

virtual void StartForMorphing (CriLipsMouth.Info silenceInfo)
 Passes the shape information of a closed mouth to ICriLipsMorph. More...
 
virtual void UpdateLipsParameter ()
 Passes the LipSync analysis result value to ICriLipsMorph. More...
 

Properties

CriLipsAtomAnalyzer atomAnalyzer [get, protected set]
 CriLipsAtomAnalyzer used internally More...
 
ICriLipsMorph LipsMorph [get, set]
 Registering the interface for the module using the LipSync analysis results More...
 

Detailed Description

Component that operates ICriLipsMorph in conjunction with CriAtomSource.

Description:
A component used to pass the mouth shape information (obtained by analyzing the voice played by a CriAtomSource) to ICriLipsMorph.

Member Enumeration Documentation

enum UpdateScheduleType
stronginherited

Timing for reflecting the analysis results

Description:
This is the timing at which the CriWare.CriLipsDeformer.LipsMorph interface will reflect the LipSync analysis results.
See also
CriWare.ICriLipsMorph.Update
Enumerator
LateUpdate 

Equivalent to MonoBehaviour.LateUpdate

Update 

Equivalent to MonoBehaviour.Update

Manual 

Arbitrary user-defined timing

Member Function Documentation

bool AttachToAtomSource ( CriAtomSourceBase  source)
inline

Attaches to the AtomSource to be analyzed

Parameters
sourceCriAtomSource
Returns
True if the setting succeeded, false if it failed
Description:
Attach to the CriAtomSource to be analyzed.
After calling this function, the audio played by the CriAtomSource will be analyzed and reflected in the blend shape.
If null is passed as an argument, the currently attached CriAtomSource will be detached.
Calling this function clears the internal state.
Note:
If it is already attached to a CriAtomSource when this function is called, it will be detached internally and then attached to the new CriAtomSource to be analyzed.
See also
CriLipsAtomAnalyzer::DetachFromAtomExPlayer
virtual void StartForMorphing ( CriLipsMouth.Info  silenceInfo)
inlineprotectedvirtualinherited

Passes the shape information of a closed mouth to ICriLipsMorph.

Description:
This is the closed mouth shape information returned by ICriLipsMorph .
To express the mouth movement, use the difference between the mouth shape information obtained in real-time
and the closed mouth information.
See also
CriLipsMouth::GetInfoAtSilence
virtual void UpdateLipsParameter ( )
inlineprotectedvirtualinherited

Passes the LipSync analysis result value to ICriLipsMorph.

Description:
Pass the LipSync analysis result value to the registered ICriLipsMorph.
If CriLipsDeformer::UserModifyDelegate is registered, the LipSync analysis result value is passed to the registered ICriLipsMorph
after being processed by the analysis result modification delegate.
See also
CriLipsDeformer::UserModifyDelegate
void ManualUpdate ( )
inlineinherited

Updating ICriLipsMorph (manual operation)

Description:
Manually update the registered ICriLipsMorph processing which is supposed to be periodically called.
If UpdateSchedule is one of the following values, the update will be called automatically at the corresponding timing.
Note:
In order to call this function, you must set UpdateSchedule to UpdateScheduleType.Manual in advance.
See also
CriLipsDeformer::UserModifyDelegate

Member Data Documentation

UpdateScheduleType UpdateSchedule
inherited

Setting the timing at which the analysis results are reflected

Description:
Get or set the timing at which the CriWare.CriLipsDeformer.LipsMorph interface
will reflect the analysis results.
The CriWare.ICriLipsMorph.Update function of the registered interface will be called according this value.
*
Note:
If you want to trigger an update at a specific time in your application, use UpdateScheduleType.Manual
and call CriLipsDeformer.ManualUpdate at any time of your choosing.
See also
CriWare.ICriLipsMorph.Update

Property Documentation

CriLipsAtomAnalyzer atomAnalyzer
getprotected set

CriLipsAtomAnalyzer used internally

Description:
If you want to control CriLipsAtomAnalyzer directly, get it from this property.
ICriLipsMorph LipsMorph
getsetinherited

Registering the interface for the module using the LipSync analysis results

Description:
Registers the interface for the module using the LipSync analysis results.
If an interface has already been registered, ICriLipsMorph::Reset is called to perform the unregistration process.
See also
ICriLipsMorph::Reset

The documentation for this class was generated from the following file: