就业培训     下载中心     Wiki     联络 登录   注册
  1. 首页
  2. C4D R23.110 C++ SDK
所有成员列表

Probe Class Reference

#include <customgui_soundeffector.h>

详细描述

Represents a probe in a SoundData.

由于
R19

Constructor/Destructor

  Probe ()=default
virtual  ~Probe ()

Right/left Bottom/Top Values

Float   GetRight () const
Float   GetLeft () const
Float   GetBottom () const
Float   GetTop () const
Bool   SetRight ( Float right)
Bool   SetLeft ( Float left)
Bool   SetTop ( Float top)
Bool   SetBottom ( Float bottom)

Validate

void  ValidateDimensions ()

Calculation Values

Bool   _clamp
Int32   _colorMode
Int32   _samplingMode
Float   _strength
向量   _color
GeData   _gradient
Float   _fadePercentage
Bool   _freeze
maxon::BaseArray < Float >  _freezeArray

构造函数 & 析构函数文档编制

◆  Probe()

Probe ( )
default

Default constructor.

◆  ~Probe()

virtual ~ Probe ( )
virtual

Destructor.

成员函数文档编制

◆  GetRight()

Float GetRight ( ) const

Retrieves the right value of probe in Hertz.

返回
The probe right value in Hertz [1...22050].

◆  GetLeft()

Float GetLeft ( ) const

Retrieves the left value of probe in Hertz.

返回
The probe left value in Hertz [1...22050].

◆  GetBottom()

Float GetBottom ( ) const

Retrieves the bottom value of probe as normalized ratio.

返回
The probe bottom value [0...1].

◆  GetTop()

Float GetTop ( ) const

Retrieves the top value of probe in normalized ratio.

返回
The probe top value [0...1].

◆  SetRight()

Bool SetRight ( Float   right )

Sets the right value of probe in Hertz [1...22050].

参数
[in] right The right value to set.
返回
true if successful, otherwise false .

◆  SetLeft()

Bool SetLeft ( Float   left )

Sets the left value of probe in Hertz [1...22050].

参数
[in] left The left value to set.
返回
true if successful, otherwise false .

◆  SetTop()

Bool SetTop ( Float   top )

Sets top value of probe as normalized ratio [0...1].

参数
[in] top The top value to set.
返回
true if successful, otherwise false .

◆  SetBottom()

Bool SetBottom ( Float   bottom )

Sets bottom value of probe as normalized ratio [0...1].

参数
[in] bottom The bottom value to set.
返回
true if successful, otherwise false .

◆  ValidateDimensions()

void ValidateDimensions ( )

Validates probe dimensions. Swaps Left/Right - Top/Bottom if values are inverted.

Member Data Documentation

◆  _clamp

Bool _clamp

Set to true (default) to limit the output of the probe from 0.0 to 1.0 and ignore values outside of the range.

◆  _colorMode

Int32 _colorMode

The color mode.

◆  _samplingMode

Int32 _samplingMode

The probe mode.

◆  _strength

Float _strength

Overall strength multiplier for the probe.

◆  _color

向量 _color

Color of the probe used when the probe's color mode is Custom Color.

◆  _gradient

GeData _gradient

渐变 of the probe used when the probe's color mode is Custom 渐变 .

◆  _fadePercentage

Float _fadePercentage

Fade percentage for decay.

◆  _freeze

Bool _freeze

Freeze state of the output.

◆  _freezeArray

maxon::BaseArray < Float > _freezeArray

Freeze values of the output.