2022-05-10

XYScope API(JavaDocを翻訳）

Proce55ingで遊ぶ #ソフトウェア

まだサンプルコードを動かしただけなんだけど、予想がつくところから翻訳した

わけがわからないところは原文のまま放置中

実際に使ってわかったら更新予定

とりあえず、

Class XYscope

java.lang.Object

xyscope.XYscope

public class XYscope
extends java.lang.Object
Render vector graphics on a vector display (oscilloscope X-Y mode, laser) by converting them to audio .

Modifier and Type	Class and Description
class	XYscope.XYShape
class	XYscope.XYShapeList

フィールドサマリ

Type	Field and Description
AudioOutput	outXY ライブラリminim から継承、オーディオ出力モデル（XY）
AudioOutput	outZ ライブラリminim から継承、オーディオ出力モデル（Z用）
float	shapeB
float	shapeG
float	shapeR
XYscope.XYShapeList	shapes buildWaves()で描画されるshapeのコレクション
float	shapeX
float	shapeY
float	shapeZ
Summer	sumXY ライブラリminimから継承　加算フィルタ（XY平面用） Summer, for customizing patching filters.
Summer	sumZ ライブラリminimから継承　加算フィルタ（Z方向用） minim Summer, for customizing patching filters.
Oscil	waveB ライブラリminimから継承ウェーブジェネレータ minim Oscil, for customizing Laser RGB oscillators.
Oscil	waveG ライブラリminimから継承ウェーブジェネレータ minim Oscil, for customizing Laser RGB oscillators.
Oscil	waveR ライブラリminimから継承ウェーブジェネレータ minim Oscil, for customizing Laser RGB oscillators.
Oscil	waveX ライブラリminimから継承ウェーブジェネレータ minim Oscil, for customizing XYZ oscillators.
Oscil	waveY ライブラリminimから継承ウェーブジェネレータ minim Oscil, for customizing XYZ oscillators.
Oscil	waveZ ライブラリminimから継承ウェーブジェネレータ minim Oscil, for customizing XYZ oscillators.

コンストラクタサマリ

XYscope(PApplet theParent)

setup()でXYscopeインスタンスを初期化, ディフォルト設定

XYscope(PApplet theParent, AudioOutput outMix)

setup()のなかでXYscopeインスタンスを初期化、及び既存の信号へのパッチ

XYscope(PApplet theParent, java.lang.String xyMixer, int sampleR)

setup()のなかでXYscopeインスタンスを初期化、カスタムサウンドカードの初期化、及びサンプリングレートを設定 (44100, 192000).

メソッドサマリ

Type	Method and Description
PVector	amp() 現在の設定音量を得る
void	amp(float newAmp) XYZ全ての波高を一律に設定する
void	amp(float newAmpX, float newAmpY) X 、 Y の波高を個別に設定する
void	amp(float newAmpX, float newAmpY, float newAmpZ) X 、 Y 、 Z の波高を個別に設定する
void	amp(PVector newAmp) 各波高（XYZ）をPVector （３値）で設定する
void	beginShape() シェイプの開始を宣言
void	buildWaves() 登録された点やシェイプに基づきXY(Z) の各波形をオシレーター描画用オーディオ信号に変換
void	buildWaves(int bwm) 登録された点やシェイプに基づきXYの各波形をオシレーター描画用オーディオ信号に変換
void	buildX(float newWave) X 軸オシレータの波形をカスタマイズする
void	buildY(float newWave) Y 軸オシレータの波形をカスタマイズする
void	buildZ(float newWave) Z 軸オシレータの波形をカスタマイズする
void	clearWaves() buildWaves()で生成した波形をクリアする
void	curveVertex(float x, float y) 曲線vortexを追加する。（現在は通常vertexー改修予定）
void	curveVertex(float x, float y, float z) 曲線vortexを追加する。（現在は通常vertexー改修予定）
boolean	debugView() デバッグビューがアクティブか否か
void	debugView(boolean debugBool) デバッグビューの表示／非表示の切り替え
void	drawAll() 登録されている全ての描画情報（drawPath() 、drawWaveform()、 drawWave()、 drawXY() 、drawPoints()）を描画する
void	drawPath() 登録されているPath情報（drawPath() ）を描画する
void	drawPoints() 登録されている点情報（drawPoint() ）を描画する。（3Dでは楕円体）
void	drawRGB() Draw waveform of all laser RGB oscillators.
void	drawWave() Draw wave of all XYZ oscillators.
void	drawWaveform() Draw waveform of all XYZ oscillators.
void	drawXY() Simulate X-Y mode of oscilloscope output.
boolean	ease() buildWaves()によるフレーム間のイージング設定を取得
void	ease(boolean easeBool) buildWaves()によるフレーム間のイージング設定をオン／オフ
float	easeAmount() 現在のイージング値（0.0 - 1.0.）を取得
void	easeAmount(float newEaseValue) buildWave()によるフレーム間のイージング値を設定
void	ellipse(float x, float y, float w, float h) 楕円(x, y, w, h)を描く
int	ellipseDetail() 楕円描画の詳細度（点の数）を取得
void	ellipseDetail(int newED) 楕円描画の詳細度（点の数）を設定
void	endShape() シェイプの終了を宣言
PVector	freq() X, Y, Z オシレーターの現在の周波数をPVectorの形で取得
void	freq(float newFreq) X, Y, Z オシレーターの周波数を一律に設定
void	freq(float newFreqX, float newFreqY) X 、 Y オシレータの周波数を個別に設定
void	freq(float newFreqX, float newFreqY, float newFreqZ) X、 Y 、 Zオシレータの周波数を個別に設定
void	freq(PVector newFreq) PVectorを使ってX、 Y 、 Zオシレータの周波数を個別に設定
void	getMixerInfo() 利用可能なオーディオ入出力のリストアップ
void	laser(java.lang.String inR, java.lang.String inBG) Activate use of Laser's RGB by assigning 3 additional (2x stereo pairs) audio channels for controlling the RGB modulation. inR - String for name of audio channel for Red inBG - String for name of audio channel for Blue/Green
float	laserLPF() Returns current frequency of Laser's low-pass-filter (LPF).
void	laserLPF(float newLaserLPFVal) Set new frequency for Laser's low-pass-filter (LPF) as float. newLaserLPFVal - float between 0.1 - 20000.0
float	limitPath() Returns current value for border that limtis rendering to edges of screen.
void	limitPath(float newLimitVal) Only render points within specified border from the edge
float	limitPoints() 描画ポイント上限数を取得
void	limitPoints(int newLimitPointsVal) 描画ポイント上限数を設定
void	line(float x1, float y1, float x2, float y2) ２D直線描画 (x1, y1)->( x2, y2).
void	line(float x1, float y1, float z1, float x2, float y2, float z2) ３D直線描画 (x1, y1, z1)->(x2, y2, z2).
void	point(float x, float y) ２D点(x, y)描画
void	point(float x, float y, float z) ３D点(x, y, z)描画
void	rect(float x, float y, float w, float h) ２D四辺形(x, y, w, h)描画
void	rectMode(int rectModeVal) 四辺形描画モード設定 (Processing の同関数参照).
boolean	smoothWaves() 波形スムージングモードか否かを確認
void	smoothWaves(boolean smoothWavesBool) 波形スムージングモードの有効化／無効化
int	smoothWavesAmount() 波形スムージングのためのステップ数を取得
void	smoothWavesAmount(int swAmount) 波形スムージングのためのステップ数を設定
float	spotKiller() spot-killer値（laserの最小描画サイズ）を取得
void	spotKiller(float newLaserCutoffVal) spot-killer値（laserの最小描画サイズ）を設定
void	stroke(float r, float g, float b) RGB laserの線幅を個別に設定
void	stroke(PVector rgb) RGB laserの線幅をVectorで個別に設定
PVector	strokeDash() 現在のRGB laser波形用のダッシュ間隔を取得
void	strokeDash(int newDash) 現在のRGB laser波形用のダッシュ間隔を設定
void	strokeDash(int newDashR, int newDashG, int newDashB) 各RGB laserのダッシュ間隔を個別に設定
void	strokeDash(PVector newDash) PVectorで各RGB laserのダッシュ間隔を個別に設定
PVector	strokeFreq() R, G, B laser の各周波数を PVectorで取得
void	strokeFreq(float newFreq) R, G, B laser の各周波数を一律に設定
void	strokeFreq(float newFreqR, float newFreqG, float newFreqB) R + G + B laser の各周波数を個別に設定.
void	strokeFreq(PVector newFreq) R + G + B laser の各周波数を Vectorで個別に設定
PVector	strokeMin() RGB laser用の各最小線幅をPVectorで取得
void	strokeMin(float minR, float minG, float minB) RGB laser用の各最小線幅を個別に設定各線幅は 0.0 - 255.0　の範囲
void	strokeMin(PVector minPV) RGB laser用の各最小線幅をPVectorで個別に設定
PVector	strokeWB() RGB laser用のホワイトバランスの設定値をPVectorで取得
void	strokeWB(float wbR, float wbG, float wbB) RGB laser用のホワイトバランスを個別に設定各設定値は0.0 - 255.0の値
void	strokeWB(PVector wbPV) RGB laser用のホワイトバランスをPVectorで個別に設定各設定値は0.0 - 255.0の値
void	vectrex() XYscope を「modded Vectrex 」接続モードにする
void	vectrex(int vrot) （同上）
void	vectrex(int vw, int vh, float vamp, int vrot) （同上）
float	vectrexRatio() Vectrex用の波高差を取得
void	vectrexRatio(float vectrexAmpVal) Vectrex用の波高差を設定
void	vertex(float x, float y) ２Dシェイプにvertexを追加
void	vertex(float x, float y, float z) ３Dシェイプにvertexを追加
void	vertex(PVector p) ３Dシェイプにvertexを追加
java.util.ArrayList<PVector>	wavePoints() ベクター描画に用いられる各軸の（単位）ベクトルをPVectorのListで取得
void	waveReset() XYZ オシレータがスリップするような時に波形のタイムステップをリセットする
int	waveSize() 波形テーブルのサイズを取得
void	waveSize(int newSize) 波形テーブルのサイズをカスタマイズする
void	z(java.lang.String zMixer) Z軸をカスタムサウンドカードに接続（パッチ）する
void	z(java.lang.String zMixer, int sampleR) ミキサーデバイス名（String) とサンプルレート (44100, 192000)を指定して Z軸をカスタムサウンドカードに接続（パッチ）する
boolean	zAuto() Z軸の波形が自動描画モードか否かを取得
void	zAuto(boolean zAutoBool) Z軸の波形が自動描画モードか否かを設定
float	zRange() Z軸用出力の最大／最小（閾）値をペア値（float[]）で取得
void	zRange(float zMin, float zMax) Z軸用出力の最大／最小（閾）値をセットで設定