Expressions/ja

概要

オブジェクトのプロパティーを数式で定義することが可能です。GUIでは、プロパティーを表す数値調整ボックスまたは入力フィールドを選択すると、青いアイコンが表示されます。アイコンをクリックするか等号記号=をキーボードから入力すると、そのプロパティーの数式エディターが開きます。もしインプットフィールドに青いアイコンではなく...ボタンが表示されている場合は、プロパティーを右クリックし、コンテキスト・メニューから数式...を選択すると数式エディターが開きます。

FreeCADにおける数式は、以下で説明する演算子、関数、定義済み定数を組み合わせた数式です。これらに加えて、他のオブジェクト・プロパティー（の値）を参照したり、条件式も使えます。数式における数値に単位を与えることも可能です。

数値の整数部分と小数部分を分けるには、コンマ,または小数点.のどちらも使えます。小数点（または小数コンマ）がある場合、少なくとも1桁以上の小数が必須です。したがって、1. + 2.や1, + 2,は正しい数式ではありませんが、1.0 + 2.0や1,0 + 2,0は正しい数式です。

もし単位が与えられた場合、演算子や関数は単位が正しく揃っていることを要求します。例えば、2mm + 4mmは正しい数式ですが、2mm + 4は正しい数式ではありません。これは他のオブジェクト・プロパティーを参照するときにも適用されます。オブジェクトプロパティーが長さを表している場合、Pad001.Length + 1は、長さと無次元数を加算しようとしているので、正しい数式ではありません。これは、Pad001.Length + 1mmのように書かなければなりません。

単位に関連するエラーは直感的でない場合があります。式が拒否されたり、式の結果の単位が設定するプロパティの単位と一致しないことがあります。以下にいくつかの例を示します：

1/2mmは0.5ミリメートルになりません。これは1/(2mm)と解釈された結果、0.5 mm^-1になります。

sqrt(2)mmは正しい数式ではありません。なぜなら、関数（sqrt）は数ではないためです（訳注：単位の前は数でなければならない）。したがってsqrt(2) * 1mmのように記述する必要があります。

関数の引数

関数に複数の引数を与える場合、各引数は、セミコロン;またはコンマ+空白, で区切る必要があります。後者の場合、コンマは入力後セミコロンに置き換えられます。セミコロンを使う場合、その後に空白をつける必要はありません。

スプレッドシートのセルを引数として使うこともできます。セルの参照は、A1のように大文字の列名に行番号をつなげて表した形で参照できます。あるいは、セルに別名が定義されている場合、Spreadsheet.MyPartWidthのように別名でも参照できます。

オブジェクトの参照

既に上で例を示したとおり、オブジェクトをデータName（名前）あるいはデータLabel（ラベル）で参照できます。データLabelで参照する場合、ラベル名を<<と>>で括り、<<ラベル>>のようにしなければなりません。

オブジェクトのプロパティーも参照できます。例えば、円柱（Cylinder）の高さ（Height）は、Cylinder.Heightあるいは<<Cylinderのラベル>>.Heightで参照できます。

It is possible to add custom properties to objects and use those in expressions. To reference constraints in sketches it is advisable to name them.

オブジェクトの参照の詳細については、CADデーターの参照を参照してください。

演算子	説明
+	加算
-	減算
*	乗算
/	浮動小数点の除算
%	剰余
^	べき算（指数）

関数	説明	入力の定義域
`acos(x)`	逆余弦（arccosine）	-1 <= x <= 1
`asin(x)`	逆正弦（arcsine）	-1 <= x <= 1
`atan(x)`	逆正接（arctangent）、-90° < 返り値 < 90°	すべて
`atan2(y; x)`	y/xの逆正接（arctangent）、象限によって-180° < 返り値 <= 180°	すべて、ただし無効入力である x = y = 0 の場合は0を返す
`cos(x)`	余弦（cos）	すべて
`cosh(x)`	双曲線余弦関数（cosh）	すべて
`sin(x)`	正弦（sin）	すべて
`sinh(x)`	双曲線正弦（sinh）	すべて
`tan(x)`	正接（tan）	all, except x = n*90 with n = odd integer
`tanh(x)`	双曲線正接（tanh）	すべて
`hypot(x; y)`	ピタゴラス和、 $\sqrt{x^{2} + y^{2}}$ （訳注：関数名は斜辺（hypotensue）から）、例えば hypot(4; 3) = 5	x >=0 かつ y >= 0
`cath(x; y)`	直角三角形の斜辺と一辺が与えられたとき、残る一辺を返す。例えば cath(5; 3) = 4	x >= y >= 0

関数	説明	入力の定義域
`exp(x)`	指数関数	すべて
`log(x)`	自然対数（eを底とする対数）	x > 0
`log10(x)`	常用対数（10を底とする対数）	x > 0
`pow(x; y)`	べき乗	すべて
`sqrt(x)`	平方根	x >= 0
`cbrt(x)` introduced in 0.21	立方根	すべて

関数	説明	入力の値域
`abs(x)`	絶対値	すべて
`ceil(x)`	切り上げ、xと同じかそれよりも大きい最小の整数	すべて
`floor(x)`	切り捨て、xと同じかそれよりも小さい最大の整数	すべて
`mod(x; y)`	剰余、xをyで割ったときの余り。結果の符号は、被除数（x）の符号と一致。	y = 0 以外
`round(x)`	四捨五入、もっとも近い整数。	すべて
`trunc(x)`	0への丸め、0の方向にも最も近い整数。	すべて

Function	Description	Input range
`and(a; b; c; ...)`	AND: 1 if abs of all arguments is greater than or equal to 1e-7, else 0	all
`or(a; b; c; ...)`	OR: 0 if abs of all arguments is less than 1e-7, else 1	all
`not(a)`	Negation: 1 if abs(a) is less than 1e-7 else 0	all

関数	説明	入力の定義域
`average(a; b; c; ...)`	引数の値の平均、sum(a; b; c; ...) / count(a; b; c; ...) と同じ。	すべて
`count(a; b; c; ...)`	計数、すなわち引数の個数。セルのレンジとともに使われることが多い。	すべて
`max(a; b; c; ...)`	引数の中の最大値。	すべて
`min(a; b; c; ...)`	引数の中の最小値。	すべて
`stddev(a; b; c; ...)`	引数の標準偏差。	すべて
`sum(a; b; c; ...)`	引数すべての合計。セルのレンジとともに使われることが多い。	すべて

型	関数	説明
`Tuple`	`tuple(a; b; ...)`	例：`tuple(2; 1; 2)`
`List`	`list(a; b; ...)`	例：`list(2; 1; 2)`
`Vector`	`vector(x; y; z)`	3つの無次元数または`長さ`の単位を持つ数でベクトルを生成する。例：`vector(2; 1; 3)`
`Vector`	`create(<<vector>>; x; y; z)`	3つの無次元数または`長さ`の単位を持つ数でベクトルを生成する。例：`vector(2; 1; 3)`
`Matrix`	matrix( a₁₁; a₁₂; a₁₃; a₁₄; a₂₁; a₂₂; a₂₃; a₂₄; a₃₁; a₃₂; a₃₃; a₃₄; a₄₁; a₄₂; a₄₃; a₄₄ )	4行4列の行列を行優先順で作成: $[\begin{matrix} a_{11} & a_{12} & a_{13} & a_{14} \\ a_{21} & a_{22} & a_{23} & a_{24} \\ a_{31} & a_{32} & a_{33} & a_{34} \\ a_{41} & a_{42} & a_{43} & a_{44} \end{matrix}]$ `matrix(1)`のように引数を1つだけ与えることもできます。これは恒等行列（訳注：`((1,0,0,0)(0,1,0,0)(0,0,1,0)(0,0,0,1))`）を作成します。例： `matrix(1; 2; 3; 4; 5; 6; 7; 8; 9; 10; 11; 12; 13; 14; 15; 16)`
`Matrix`	`create(<<matrix>>; a₁₁; a₁₂; ...; a₄₄)`
`Rotation` （回転）	`rotation(axis; angle)`	`Rotation`を、その軸`axis`（`ベクトル`）と角度`angle` （`角度`の単位または無次元数）、あるいは3つのオイラー角`α`、`β`、`γ`を与えて生成。例： `rotation(vector(0; 1; 0); 45)` `create(<<rotation>>; 30; 30; 30)`
	`rotation(α; β; γ)`
	`create(<<rotation>>; axis; angle)`
	`create(<<rotation>>; α; β; γ)`
`Placement` （配置 = 位置 + 回転）	`placement(base; rotation)`	`Placement`を、以下のようなパラメターから生成します。 `base`: ベース位置（`Vector`） `center`: 中心位置（`Vector`） `rotation`: `Rotation` `axis`: Rotation（回転）軸（`Vector`） `angle`: Rotation（回転）角（無次元数または`角度`の単位付きの値） `matrix`: `Matrix` 例： `placement(vector(2; 1; 3); rotation(vector(0; 0; 1); 45))` `create(<<placement>>; create(<<vector>>; 2; 1; 2); create(<<rotation>>; create(<<vector>>; 0; 1; 0); 45))`
	`placement(base; rotation; center)`
	`placement(base; axis; angle)`
	`placement(matrix)`
	`create(<<placement>>; ...)`

関数・演算子	説明
`v1 + v2`	2つのベクトルの加算。
`v1 - v2`	2つのベクトルの減産。
`v * s`	ベクトルを`s`倍一様に拡大縮小する。
`vangle(v1; v2)`	2つのベクトルの間の角度（度）。
`vcross(v1; v2)`	2つのベクトルの外積 $v_{1} \times v_{2}$ 。
`v1 * v2`	2つのベクトルの内積 $v_{1} \cdot v_{2}$ 。
`vdot(v1; v2)`	2つのベクトルの内積 $v_{1} \cdot v_{2}$ 。
`vlinedist(v1; v2; v3)`	ベクトル`v1`（で表される点）と、ベクトル`v2`（で表される点）を通り方向がベクトル`v3`である直線との距離を求める。
`vlinesegdist(v1; v2; v3)`	ベクトル`v1`（で表される点）と、ベクトル`v2`（で表される点）とベクトル`v3`（で表される点）を結んだ線分上の最も近い点との距離を求める。
`vlineproj(v1; v2; v3)`	ベクトル`v1`（で表される点）を、ベクトル`v2`（で表される点）を通り向きがベクトル`v3`である直線に投影する（訳注：直線上`v1`に最も近い点を求める）。
`vnormalize(v)`	ベクトルを単位ベクトル（長さ1のベクトル）に正規化する。
`vplanedist(v1)`	ベクトル`v1`（で表される点）と、ベクトル`v2`で表される点を通り法線の方向がベクトル`v3`である平面との距離を求める。
`vplaneproj(v1)`	ベクトル`v1`（で表される点）を、ベクトル`v2`で表される点を通り法線の方向がベクトル`v3`である平面に投影する（訳注：平面上`v1`に最も近い点を求める）。
`vscale(v; sx; sy; sz)`	x軸方向へ`sx`倍、y軸方向へ`sy`倍、z軸方向へ`sz`倍拡大縮小する。
`vscalex(v; sx)`
`vscaley(v; sy)`
`vscalez(v; sz)`

関数	説明
`minvert(m)`	逆行列を計算。
`mrotate(m; rotation)`	下記のいずれかで回転 `Rotation` 軸（`Vector`）と角度（`Angle` 単位付きまたは無次元数） 3つのオイラー角 `α`、`β`、`γ`
`mrotate(m; axis; angle)`
`mrotate(m; α; β; γ)`
`mrotatex(m; angle)`	x軸回りの回転
`mrotatey(m; angle)`	y軸回りの回転
`mrotatez(m; angle)`	z軸回りの回転
`mtranslate(m; vector)`	`vector` (`Vector`) またはX、Y、Z値に基づく平行移動。`Rotation`を平行移動すると、返り値は`Placement`になる。
`mtranslate(m; x; y; z)`
`mscale(m; vector)`	`vector` (`Vector`) またはX、Y、Z値に基づく拡大縮小
`mscale(m; x; y; z)`	`vector` (`Vector`) またはX、Y、Z値に基づく拡大縮小

単位	説明
°	度（°）単位degの別名
deg	度（°）単位°の別名
rad	ラジアン
gon	グラジアン
M	角度の分（1/60度）単位 ′ の別名
′	角度の分（1/60度）これはプライム記号（U+2032）で単位Mの別名。
S	角度の秒（1/3600度）動作しない。単位 ″ の別名。
″	角度の秒（1/3600度）これはダブル・プライム記号（U+2033）で単位 Sの別名。

単位	説明
mmol	Milliミリ・モル
mol	モル

単位	説明
mA	ミリアンペア
A	アンペア
kA	キロアンペア
MA	メガアンペア

単位	説明
pF	ピコファラッド
nF	ナノファラッド
uF	マイクロファラッド単位µFの別名
µF	マイクロファラッド単位uFの別名
mF	ミリファラッド
F	ファラッド 1 F = 1 s⁴·A²/m²/kg

単位	説明
uS	マイクロジーメンス単位µSの別名
µS	マイクロジーメンス単位uSの別名
mS	ミリジーメンス
S	ジーメンス 1 S = 1 s³·A²/kg/m²
kS	キロジーメンス
MS	メガジーメンス

単位	説明
nH	ナノヘンリー
uH	マイクロヘンリー単位µHの別名
µH	マイクロヘンリー単位uHの別名
mH	ミリヘンリー
H	ヘンリー 1 H = 1 kg·m²/s²/A²

単位	説明
Ohm	オーム（Ω） 1Ω = 1 kg·m²/s³/A²
kOhm	キロオーム（Ω）
MOhm	メガオーム（Ω）

単位	説明
mJ	ミリジュール（J）
J	ジュール（J）
kJ	キロジュール（J）
eV	電子ボルト（eV） 1 eV = 1.602176634e-19 J
keV	キロ電子ボルト（eV）
MeV	メガ電子ボルト（eV）
kWh	キロワット時 1 kWh = 3.6e6 J
Ws	ワット秒単位Jの別名
VAs	VA秒単位Jの別名
CV	クーロン・ボルト単位Jの別名
cal	カロリー（cal） 1 cal = 4.184 J
kcal	キロカロリー（cal）

単位	説明
mN	ミリニュートン（N）
N	ニュートン（N）
kN	キロニュートン（N）
MN	メガニュートン（N）
lbf	Pound of force

単位	説明
nm	ナノ（10^-9）メートル
um	マイクロ（10^-6）メートル単位 µmの別名
µm	マイクロ（10^-6）メートル単位 um の別名
mm	ミリ（10^-3）メートル
cm	センチ（10^-2）メートル
dm	デシ（10^-1）メートル
m	メートル
km	キロ（10³）メートル meter
mil	1/1000インチ単位 thou の別名
thou	1/1000インチ単位 mil の別名
in	インチ単位 " の別名
"	インチ単位 in の別名
ft	フィート単位 ' の別名
'	フィート単位 ft の別名
yd	ヤード
mi	マイル

単位	説明
ug	マイクログラム単位µgの別名
µg	マイクログラム単位ugの別名
mg	ミリグラム
g	グラム
kg	キロ（10³）グラム
t	トン
oz	Ounce
lb	Pound; alternative to the unit lbm
lbm	Pound; alternative to the unit lb
st	Stone
cwt	Hundredweight

単位	説明
Pa	パスカル
kPa	キロパスカル
MPa	メガパスカル
GPa	ギガパスカル
uTorr	マイクロトル。単位µTorrの別名。
µTorr	マイクロトル。単位uTorrの別名
mTorr	ミリトル
Torr	トル。1 Torr = 101325/760 Pa
psi	Pound-force per square inch; 1 psi = 6.895 kPa
ksi	Kilopound-force per square inch

単位	説明
uK	マイクロケルビン。単位 µK の別名
µK	マイクロケルビン。単位 uK の別名
mK	ミリケルビン
K	ケルビン

単位	説明
s	秒
min	分
h	時
Hz	ヘルツ s^-1
kHz	キロヘルツ
MHz	メガヘルツ
GHz	ギガヘルツ
THz	テラヘルツ

単位	説明	代替
°C	セルシウス温度	[°C] + 273.15 K
°F	Fahrenheit;	([°F] + 459.67) × 5/9
u	統一原子質量単位。単位Daの別名。	1.66053906660e-27 kg
Da	ダルトン。単位uの別名。	1.66053906660e-27 kg
sr	Steradian	直接的な代替はない
lm	ルーメン	直接的な代替はない
lx	ルクス	直接的な代替はない
px	ピクセル	直接的な代替はないy

Expressions/ja

概要

関数の引数

オブジェクトの参照

定義済み定数

演算子

関数

数学関数

三角関数

指数関数・対数関数

端数処理関数・剰余関数

Boolean functions

統計関数・集約関数

文字列操作

文字列の定義

文字列の連結

文字列への変換

文字列の整形

オブジェクト生成関数

ベクトル関数

行列関数

条件式

Notes

単位

物質量

角度

電流

静電容量

電荷

コンダクタンス

インダクタンス

電圧

電気抵抗

エネルギー・仕事

力

長さ

光度

磁束

磁束密度

質量

仕事率

圧力

温度

時間

容積

その他のヤード・ポンド法の単位

サポート外の単位

使えない文字や名前

ラベル

名前

セルの別名

CADデーターの参照

循環参照

ドキュメント全体からアクセス可能なグローバル変数

ドキュメントをまたがった参照

既知の問題・残課題

スクリプトからの利用

文字 / 文字列	説明
+, -, *, /, ^, _, <, >, (, ), {, }, [, ], ., ,, =	演算子や数式の構成要素に使われる文字
A, kA, mA, MA, J, K, ' , ft , °, その他	単位に使われる文字列（詳細は単位を参照）
#, !, ?, §, $, %, &, :, ;, \, \|, ~, ∆, ¿, その他	特別な操作や意味をもつ文字
pi, e	数学定数
´, `, ' , "	アクセント文字
空白	空白は名前の終わりを意味しているため、名前の一部には含められません

CADデーター	数式での参照	結果
Part Boxの長さ	`Box.Length`	長さ（mm）
Boxの体積	`Box.Shape.Volume`	mm³単位の体積（単位はなし）
Boxの形状タイプ	`Box.Shape.ShapeType`	文字列「Solid」
Boxのラベル	`Box.Label`	文字列「Label」
Boxの質量中心のx座標	`Box.Shape.CenterOfMass.x`	mm単位のx座標（単位はなし）
Box位置のx座標	`Box.Placement.Base.x`	x座標（mm）
Box位置の回転軸のx座標成分	`Box.Placement.Rotation.Axis.x`	単位ベクトルのmm単位のx座標成分（単位なし）
Box位置の回転角	`Box.Placement.Rotation.Angle`	回転角（deg）
Boxオブジェクト全体	`Box._self`	<Part::PartFeature>型のオブジェクト
スケッチの拘束条件の値	`Constraints.Width`	もし式がスケッチの中で使われた場合、同じスケッチの中の名前が`Width`という拘束条件の値
スケッチの拘束条件の値	`MySketch.Constraints.Width`	もし式がスケッチの外で使われた場合、`MySketch`の中の名前が`Width`という拘束条件の値
スプレッドシート別名の値	`Spreadsheet.Depth`	`Spreadsheet`という名前のスプレッドシートの`Depth`という名前の別名の値
ローカルなプロパティーの値	`Length`	ある（たとえば押し出し）オブジェクトのデータLengthという名前のプロパティーの値。同じオブジェクトの別のプロパティー（例えばデータLength2）の数式から呼び出す場合。