テキスト プラス: GeometryClass

TextPlus – superclass: GeometryClass; super-superclass:node – classID: #(1815478437, 291720888)

コンストラクタ

TextPlus()

プロパティ

補間のプロパティ

<TextPlus>.interpolationsteps : integer default:5

フォント スムージングの補間ステップの数です。

 <TextPlus>.optimize : integer

補間の最適化の設定です。1= オン、0= オフです。

 <TextPlus>.adaptive : integer
		  

補間のアダプティブの設定です。1= オン、0= オフです。

レイアウトのプロパティ

<TextPlus>  .layouttype : integer

レイアウト タイプです。 0= ポイント、1= 領域です。

<TextPlus>  .plane : integer

レイアウト平面です(layouttype がポイントの場合)。0= 自動、1=XY、2=XZ、3=YZ

<TextPlus>  .length : float

レイアウト領域の長さです。

<TextPlus>  .width : float

レイアウト領域の幅です。

フォントのプロパティ

  .alignment : integer

フォントの位置合わせ:

 .size : float
		  

フォント サイズです。

 .tracking : float
		  

フォント トラッキング値です。

 .leading : float
		  

フォントの行間値です。

 .vscale : float
		  

フォントの垂直スケール値(パーセント)です。

 .hscale : float
		  

フォントの水平スケール値(パーセント)です。

文字の設定

  .elementtype : integer

文字がアニメーションのプリセット用に分割される場合の分割先の要素のタイプです。

  • 0 = 文字
  • 1 = ワード
  • 2 = 行
  • 3 = 段落

  .charKerningOffset : float array

文字列内の各文字のカーニング オフセット値の配列です。

  .charBaselineOffset : float array

文字列内の各文字のベースライン オフセット値の配列です。

  .charXScale : float array

文字列内の各文字の X スケール値の配列です。

  .charYScale : float array

文字列内の各文字の Y スケール値の配列です。

ジオメトリの設定

  .generateGeometry : integer

[ジオメトリを生成](Generate Geometry)の設定(0= オフ、1= オン)。

  .extrudeamount : float

正または負の押し出しの量です。既定値は 0 です。

  .extrudesegments : integer

押し出しを構成するセグメントの数です。前方から後方に押し出された文字は、この数のセグメントに分割されます。

  .applybevel : Boolean

ベベルを文字に適用するかどうかを示します。

  .beveldepth : float

ベベルの深度です。

  .usebevelwidth (UseBevelDepth) : Boolean

.bevelwidth 設定を適用するかどうかを示します。

  .bevelwidth : float

ベベルの幅です。.usebevelwidth が true の場合のみ適用されます。

  .bevelsteps : integer

ベベルのステップの数です。 これにより、ベベル プロファイル カーブのベジェ セグメントあたりのサブディビジョン数が決まります。

  .bevelpush : float

[ベベル プッシュ](Bevel Push)値です。これは、ベベルに対して垂直なベベル プロファイル カーブに適用されるスケール係数です。値に 1.0 を指定すると、元のベベル カーブになります。値に -1.0 を指定すると、反転されたベベル カーブになります。値に 0 を指定すると、常にストレート ベベルになります。

  .beveloptimize : Boolean

ベベルが最適化されているかどうかを示します。最適化されている場合、ベベル プロファイル カーブ内の線形セグメントは単一エッジに削減され、.bevelsteps パラメータは無視されます。

  .beveloffset : float

[アウトラインのオフセット](Outline Offset)の設定正または負の値を指定できます。

キャップ有りのベベルの設定

 .capstart : integer  
  .capend : integer

ベベル文字の開始(上部)および終了(下部)のキャップ設定:

  • 0 = キャップ
  • 1 = キャップなし
  • 2 = キャップ有りのベベル
  • 3 = キャップなしのベベル
.capstartconstrain : boolean
.capendconstrain : Boolean

ベベル文字の開始(上部)および終了(下部)のキャップ コンストレイントの設定です。

  .captype : integer

[キャップ タイプ](Cap Type)の設定:

  • 0 = モーフ
  • 1 = グリッド
  .startcapmaterial : integer
  .startbevelmaterial : integer
  .sidematerial : integer
  .endbevelmaterial : integer
  .endcapmaterial : integer

開始キャップ、開始ベベル、側面、終了ベベル、終了キャップにそれぞれ関連付けられているマテリアルの ID です。

  .macroname : string array
  .macroflags : int array
  .macrovalue : float array
  .upaxis : integer

「アップ」軸の設定:

  • 0 = X
  • 1 = Y
  • 2 = Z
  .axisflip : Boolean

軸を反転するかどうかを示します。

  .nodeElements : node array
  .nodeElementsCenters : point3 array
  .BevelProfileCurve

オブジェクト タイプが ReferenceTarget:BevelProfileCurve のベベル プロファイル カーブです。 このタイプは現在 MAXScript に公開されていません。

メソッド

メソッドは インタフェース: textObject2 を介して公開されます。

    <void>GetRTFString <&TSTR>rtfstring

rtfstring は出力パラメータです。

オブジェクト文字列を RTF 形式で返します。

    <boolean>SetRTFString <string>string

オブジェクト文字列を RTF 形式の文字列として設定します。このメソッドはすべてのフォーマット設定をクリアします(ResetStyle()の呼び出しに相当)。

    <void>GetPlaintextString <&TSTR>textstring

textstring は出力パラメータです

オブジェクト文字列を書式設定のないプレーン テキスト文字列として取得します。

    <boolean>SetPlaintextString <string>string

オブジェクト文字列を書式設定のないプレーン テキスト文字列として設定します。このメソッドはすべてのフォーマット設定をクリアします(ResetStyle()の呼び出しに相当)。

    <void>ResetString()

オブジェクト文字列を空の文字列にリセットします。

書式設定メソッド

これらのメソッドは現在の文字の書式設定に影響します。これらを呼び出しても、テキスト プラス オブジェクトの文字列に含まれる既存の文字の書式設定には影響しません。AppendString()を使用して以降に追加される文字に影響します。SetPlaintextString()または SetRTFString()を呼び出すと、すべての書式設定がリセットされます。

これらのメソッドを使用して文字列を作成および書式設定する方法については、以下の「コード サンプル」セクションを参照してください。

 <boolean>SetFont <string>fontName <integer>charset
		  

現在のフォントの選択内容、および文字セットのインデックスを設定します。

 <void>SetBold <boolean>sw		  
 <void>SetItalic <boolean>sw
 <void>SetUnderline <boolean>sw
 <void>SetStrikethrough <boolean>sw
<void>SetSubscript <boolean>sw
<void>SetSuperscript <boolean>sw
<void>SetAllCaps <boolean>sw
 <void>SetSmallCaps <boolean>sw		  		  		  

これらのすべてのメソッドは文字の書式設定オプションを設定します(true= オン、false= オフ)。

 <void>ResetStyle() 
		  

すべての文字の書式設定を既定値にリセットします。

 <void>AppendString <string>string
		  

指定された文字列をテキスト プラス オブジェクトの文字列に追加します。追加された文字列に現在の文字の書式設定を使用します。

 <void>AppendChar <integer>character
		  

ASCII コードで指定された文字をテキスト プラス オブジェクトの文字列に追加します。文字列のソースが RTF の場合、このメソッドは改行を追加します。

アニメーションのメソッド

    <boolean>SetCharBaseline <index>index <time>time <worldUnits>value
    <boolean>SetCharKerning <index>index <time>time <worldUnits>value
<boolean>SetCharXScale <index>index <time>time <float>value
<boolean>SetCharYScale <index>index <time>time <float>value

これらのメソッドは、インデックスで指定された文字のアニメート可能な値を、指定時刻に、指定された値に設定します。これらのメソッドを使用する前に[アニメート](Animate)をオンに設定する必要があります。

    <integer>GetNumChars()

テキスト プラス文字列内の文字数を返します。

    <boolean>GetCharacter <index>index <&integer>character <&TSTR>fontName <&integer>charSet <&DWORD>style

character は出力パラメータです

fontName は出力パラメータです

charSet は出力パラメータです

style は出力パラメータです

指定したインデックスの文字の書式設定情報を取得します。

    <boolean>SetCharacter <index>index <integer>character <TSTR>fontName <integer>charSet <DWORD>style

指定したインデックスにある文字の文字(ASCII コードで指定)、フォント、文字セット、およびスタイルを設定します。

[スタイル](Style)は次の値を取るビット フラグです。

  • 0= プレーン
  • 1= 斜体
  • 2= 下線
  • 4= 太字
  • 8= 取り消し線
  • 16= すべて大文字
  • 32= 小型英大文字
  • 64= 上付き文字
  • 128= 下付き文字
    <index>GetSeparationType()
    <boolean>SetSeparationType <index>type

アニメーション分割設定を取得または設定します。

  • 1= オブジェクト
  • 2= 文字
  • 3= ワード
  • 4= 行
  • 5= 段落
    <void>GetSeparationUpAxis <&index>axis <&boolean>flip

axis は入出力パラメータです

flip は入出力パラメータです

    <boolean>SetSeparationUpAxis <index>axis <boolean>flip

アニメーションの「アップ」軸および[軸を反転](Flip Axis)の設定を取得または設定します。

  • 1=X
  • 2=Y
  • 3=X

文字の設定のアニメーション メソッド

    <boolean>GetCharBaseline <index>index <time>time <&worldUnits>value <&interval>valid 
   <boolean>GetCharKerning <index>index <time>time <&worldUnits>value <&interval>valid
    <boolean>GetCharXScale <index>index <time>time <&float>value <&interval>valid
    <boolean>GetCharYScale <index>index <time>time <&float>value <&interval>valid

value は出力パラメータです

valid は入出力パラメータです

これらのメソッドは指定されたインデックスおよび時刻における文字のベースライン、カーニング、X および Y スケール値を取得します。また、値の有効性の間隔も返します。

キャラクタ メッシュのメソッド

    <boolean>GetCharGlyphMesh <index>index <time>time <&mesh>mesh <&interval>valid
    <boolean>GetCharExtrasMesh <index>index <time>time <&mesh>mesh <&interval>valid
    <boolean>GetCharTotalMesh <index>index <time>time <&mesh>mesh <&interval>valid

mesh は入出力パラメータです

valid は入出力パラメータです

これらのメソッドは、指定されたインデックスおよび時刻においてキャラクタに関連付けられているメッシュ オブジェクトを取得します。これらのメソッドはメッシュ(TriMesh オブジェクトとして)および有効性の間隔を返します。

コード サンプル

次のコード サンプルは、テキスト プラス オブジェクトを構築し、書式設定された文字列を作成し、個々の文字をアニメートします。

--Simple text construction and Animation with TextPlus


actionMan.executeAction 0 "40005" -- Reset

TextPlus layouttype:0  Plane:0 transform:(matrix3 [1,0,0] [0,0,1] [0,-1,0] [0,0,0]) isSelected:on
$.ResetString()
-- Default font is Arial but you can set whatever
$.SetFont "Arial" 0
$.ResetStyle()
$.AppendString "My "
$.SetBold true
$.SetItalic true
$.AppendString "Text "
$.ResetStyle()
$.SetFont "Tahoma" 0
$.SetUnderline true
$.AppendString "String"
$.SetUnderline false
$.AppendChar 32    -- space
$.AppendChar 33 -- Exclamation

-- Now let's do some simple animation

set animate on

--M
$.SetCharBaseline 1 10 -40
$.SetCharBaseline 1 20 40
$.SetCharBaseline 1 30 -40
$.SetCharBaseline 1 40 0

--y
$.SetCharBaseline 2 10 40
$.SetCharBaseline 2 20 -40
$.SetCharBaseline 2 30 40
$.SetCharBaseline 2 40 0

--T
$.SetCharBaseline 4 10 0
$.SetCharBaseline 4 20 40
$.SetCharBaseline 4 30 -40
$.SetCharBaseline 4 40 40
$.SetCharBaseline 4 50 0

--e
$.SetCharBaseline 5 10 0
$.SetCharBaseline 5 20 -40
$.SetCharBaseline 5 30 40
$.SetCharBaseline 5 40 -40
$.SetCharBaseline 5 50 0

--!
$.SetCharYScale 16 10 1
$.SetCharYScale 16 20 3
$.SetCharYScale 16 30 -3
$.SetCharYScale 16 40 3
$.SetCharYScale 16 50 1

set animate off