Nodeクラス

NodeRef : Node

Worldオブジェクトが作成されたときに、"Node"という名前のオブジェクトが自動作成されます。

メソッド

LayerInfo    LayerGroupInfo    LayerBundleInfo    LayerTree    show    hide    addChild    isAnimated    hasMotion    translate    rotate    Listing   

_W3DObject クラスから継承されるメソッド

Counter    deleteObject    deleteUnusedObjs    exchangeObjects    exchangeValues    getExchangeState    getObjectProp    Listing    newObject    setExchangeState    setObjectProp    watchObjects   

_Object クラスから継承されるメソッド

activate    addEvent    dispatchSolaEvent    getVal    isActivated    removeEvent    setVal    test   

_Object クラスから継承されるプロパティ

class   

3Dオブジェクト プロパティ

scale    type    label    locked    nameTags    parent    child    isInWorld    transform    position    positionX    positionY    positionZ    rotation    rotationX    rotationY    rotationZ    scaleX    scaleY    scaleZ    worldTransform    worldPosition    worldPositionX    worldPositionY        worldRotation    worldRotationX    worldRotationY    worldScale    worldScaleX    worldScaleY    centerPos    boundingSize    nTransform    geometry    material    visibility    rootNode    perspective    fov    hfov    dfov    hither    yon    orthoHeight    fog    fogColor    fogNear    fogDecay    style    color    spotAngle    spotDecay    attenuation    attenuationX    attenuationY    attenuationZ    specular   

メソッドの詳細

LayerInfo

NodeRef.LayerInfo( ) : Array

レイヤーの情報を示すオブジェクトの配列です。各オブジェクトは以下のプロパティを持ちます。
name:String - ノード名。
label:String - 表示名。
state:Boolean - レイヤが表示されているかどうか。

LayerGroupInfo

NodeRef.LayerGroupInfo() : Array

レイヤーグループの情報を示すオブジェクトの配列です。各オブジェクトは以下のプロパティを持ちます。
name:String - ノード名。
label:String - 表示名。
relatedNames:Array - グループ化されているノード名の配列。
relatedLabels:Array - グループ化されているノードの表示名の配列。
state:Number - 表示されているレイヤ番号。

LayerBundleInfo

NodeRef.LayerBundleInfo() : Array

レイヤーバンドルの情報を示すオブジェクトの配列です。各オブジェクトは以下のプロパティを持ちます。
name:String - ノード名。
label:String - 表示名。
relatedNames:Array - 関連づけされたノード名の配列。
relatedLabels:Array - 関連づけされたノードの表示名の配列。

LayerTree

NodeRef.LayerTree( attributeNames:Array ) : String

階層化されたレイヤーの情報を示す XMLストリングです。各XMLノードは、attributeNamesで指定したプロパティの属性を持ちます。

パラメータ

attributeNames:Array ― XMLノードに作成される属性名の配列です。属性名は、3Dノードオブジェクトのプロパティと対です。

show

NodeRef.show( Node:String ) : Boolean

指定した非表示ノードを表示します。hideコマンドで非表示にしたノードにのみ有効です。

パラメータ

Node:String ― ノードの名称です。

次の例は、"myWorld"ワールドの"myModel"ノードを表示します。
SOLA.myWorld.Node.show( "myModel" )
関連項目

hide  

hide

NodeRef.hide( Node:String ) : Boolean

指定したノードを隠します。hideコマンドはノードの親を一時的に Nullにします。showコマンドで親を元に戻します。

パラメータ

Node:String ― ノードの名称です。

次の例は、"myModel"ノードを隠します。
myNode.hide( "myModel" )
関連項目

hide  

addChild

NodeRef.addChild( parent:String ,child:String , { preserve:String } ) : Boolean

親ノードに子ノードを追加します。

パラメータ

parent:String ― 親のノード名です。
child:String ― 子になるノードの名前です。
preserve:String ― "World"もしくは "Parent"を指定できます。デフォルトは "World"です。 "Parent"の場合、親基準のトランスフォームを保持したまま、新しい親の子になります。結果、ワールドトランスフォームがジャンプします。 "World"の場合、子はワールドトランスフォームを保持します。

isAnimated

NodeRef.isAnimated(Node:String) : Boolean

指定したノードがアニメーションされているかどうかを調べます。モーションを持たないノードであっても親階層がモーションしている場合は TRUEを返します。

パラメータ

Node:String ― ノード名を指定します。

 次の例は、"myCamera"カメラがアニメーションしているかどうか調べます。
 var anmFlg =  myNode.isAnimated("myCamera")

hasMotion

NodeRef.hasMotion(Node:String) : Boolean

指定したノードがモーションを持っているか確認します。

パラメータ

Node:String ― ノード名を指定します。

translate

NodeRef.translate( Node:String, x:Number, y:Number, z:Number, {pivotNode:String}) : Boolean

指定したノードを移動します。

パラメータ

Node:String ― ノードの名称です。x:Number ― X軸方向の移動量です。
y:Number ― Y軸方向の移動量です。
z:Number ― Z軸方向の移動量です。
pivotNode:String ― 相対移動する場合に指定するオプションです。指定した名称のノードの座標系に対し移動が適応されます。

関連項目

rotate  scale  

rotate

NodeRef.rotate( Node:String, x:Number, y:Number, z:Number, {pivotNode:String}) : Boolean

指定したノードを移動します。

パラメータ

Node:String ― ノードの名称です。x:Number ― X軸方向の回転量です。
y:Number ― Y軸方向の回転量です。
z:Number ― Z軸方向の回転量です。
pivotNode:String ― 相対移動する場合に指定するオプションです。指定した名称のノードの座標系に対し回転が適応されます。

関連項目

translate  scale  

Listing

NodeRef.Listing( filter:String, xVal:String) : Array

ワールド内のノードオブジェクト名の配列を返します。

パラメータ

filter:String フィルタリングを指定した場合は、フィルタリングされた配列を返します。フィルタリングには次のストリングを指定できます。
"","*" 何も指定しない場合、不明なフィルタリング名の場合は、すべてのノードの配列が返ります。
"Group" グループノードの配列を返します。
"Model" モデルノードの配列を返します。
"Camera" カメラノードの配列を返します。
"Light" レイヤーノードの配列を返します。
"isInWorld" ワールドの中にあるノードを返します。
"isOutsideWorld" ワールドの外にあるノードを返します。
"hasMotion" モーションを持ったモデルノードを返します。
"hasKeyFrameMotion" キーフレームモーションを持ったモデルノードを返します。
"hasBonesMotion" ボーンモーションを持ったモデルノードを返します。
"isAnimated" アニメートされるノードを返します。
"Layer" レイヤーのノードを返します。
"LyGrp" レイヤーグループのノードを返します。
"LyBdl" レイヤーバンドルのノードを返します。
"Parent" 第二引数に指定したノードの親を返します。
"Ancestor" 第二引数に指定したノードの先祖を返します。
"Child" 第二引数に指定したノードの子を返します。
"Descendant" 第二引数に指定したノードの子孫を返します。
 

3Dオブジェクト プロパティの詳細

3Dオブジェクトのプロパティは、getObjectProp/setObjectPropメソッドで取得設定をおこないます。

scale

scale: Vector

ノードの大きさを示すスケールベクトルです。

type

type: String

ノードのタイプです。"Group","Model","Camera","Light"のいずれかです。取得のみ。

label

label: String

ノードを表示する際の自由に設定できる名前です。2byte文字も使用できます。nameプロパティは取得のみですが、labelプロパティはいつでも設定可能です。

locked

locked: Boolean

トランスフォームの変更が不可かどうか。トランスフォーム系ツールによる変更を無効にします。APIから直接変更した場合は効果がありません。

nameTags

nameTags: Array

nameプロパティに含まれるタグの配列を取得します。

parent

parent: String

親ノードの名前です。

child

child: Array

子ノードの名前の配列です。取得のみ。

isInWorld

isInWorld: Boolean

ノードが 親階層が "World"ノードのであるかどうかです。取得のみ。

transform

transform: Transform

ノードの親を基準にしたトランスフォームです。

position

position: Vector

ノードの親階層に対する位置ベクトルです。

positionX

positionX: Number

ノード位置ベクトルの X座標の値です。

positionY

positionY: Number

ノード位置ベクトルの Y座標の値です。

positionZ

positionZ: Number

ノード位置ベクトルの Z座標の値です。

rotation

rotation: Vector

ノードの親階層に対する向きを示す回転ベクトルです。

rotationX

rotationX: Number

ノード回転ベクトルの X座標の値です。

rotationY

rotationY: Number

ノード回転ベクトルの Y座標の値です。

rotationZ

rotationZ: Number

ノード回転ベクトルの Z座標の値です。

scaleX

scaleX: Number

ノード スケールベクトルの X座標の値です。

scaleY

scaleY: Number

ノード スケールベクトルの Y座標の値です。

scaleZ

scaleZ: Number

ノード スケールベクトルの Z座標の値です。

worldTransform

worldTransform: Transform

ノードのワールド原点を基準にしたトランスフォームです。

worldPosition

worldPosition: Vector

ワールド原点を基準にした ノードの位置ベクトルです。

worldPositionX

worldPositionX: Number

ワールド原点を基準にした ノード位置ベクトルの X座標の値です。

worldPositionY

worldPositionY: Number

ワールド原点を基準にした ノード位置ベクトルの Y座標の値です。

worldScaleZ: Number

ワールド原点を基準にした ノード スケールベクトルの Z座標値です。

worldRotation

worldRotation: Vector

ワールド原点を基準にした ノードの回転ベクトルです。

worldRotationX

worldRotationX: Number

ワールド原点を基準にした ノード回転ベクトルの X座標値です。

worldRotationY

worldRotationY: Number

ワールド原点を基準にした ノード回転ベクトルの Y座標値です。

worldScale

worldScale: Vector

ワールド原点を基準にした ノードの スケールベクトルです。

worldScaleX

worldScaleX: Number

ワールド原点を基準にした ノード スケールベクトルの X座標値です。

worldScaleY

worldScaleY: Number

ワールド原点を基準にした ノード スケールベクトルの Y座標値です。

centerPos

centerPos: Vector

ノード中心点の位置ベクトルです。取得のみ。

boundingSize

boundingSize: Number

ノードを囲む球体の半径です。取得のみ。

nTransform

nTransform: Transform

モーションで移動しているモデルノードのオリジナルのトランスフォームです。nTransform以外のトランスフォームプロパティは、モーション中のトランスフォームを返します。

geometry

geometry: String

モデルノードのジオメトリ名です。

material

material: Array

モデルノードに割り当てられたマテリアル名の配列です。

visibility

visibility: String

モデルノードの可視設定です。

rootNode

rootNode: String

カメラノードのルートノード名です。カメラをビューに指定した場合、ビューにはこのプロパティで指定したノード以下の子ノードがレンダリングされます。デフォルトは "World"ノードです。

perspective

perspective: Boolean

カメラノードのパースペクティブでビューに表示するかどうかです。デフォルトは true。パースペクティブでない場合は、平行投影法でレンダリングされます。

fov

fov: Number

カメラノードの垂直画角です。

関連項目

hfov  dfov 

hfov

hfov: Number

カメラノードの水平画角です。

関連項目

fov  dfov 

dfov

dfov: Number

カメラノードの対角画角です。

関連項目

fov  hfov 

hither

hither: Number

カメラノードの表示開始距離です。ビューに指定されたカメラでは、"hither"プロパティで指定された距離から、"yon"プロパティで指定された距離までの区間をレンダリングします。この区間から完全に外れたモデルノードは、リアルタイムレンダリングの計算から除外されます。レンダリング範囲を狭めることは、パフォーマンスの改善に繋がります。また、Zバッファ衝突などの表示上の問題がある場合も有効です。 常に "yonプロパティより小さい値です。

関連項目

yon 

yon

yon: Number

カメラノードの表示開始距離です。ビューに指定されたカメラでは、"hither"プロパティで指定された距離から、"yon"プロパティで指定された距離までの区間をレンダリングします。この区間から完全に外れたモデルノードは、リアルタイムレンダリングの計算から除外されます。レンダリング範囲を狭めることは、パフォーマンスの改善に繋がります。また、Zバッファ衝突などの表示上の問題がある場合も有効です。 常に "hither"プロパティより大きい値です。

関連項目

hither 

orthoHeight

orthoHeight: Number

カメラノードが平行投影の場合、ビューの垂直方向に何ユニット表示するかの設定です。

fog

fog: Boolan

フォグ(霧)効果を表示するかどうか、カメラノードのプロパティです。

fogColor

fogColor: Number

カメラノードの、フォグ効果の終了距離です。

fogNear

fogNear: Number

カメラノードの、フォグ効果の開始距離です。

fogDecay

fogDecay: String

カメラノードの、フォグ効果の減衰方法です。

style

style: String

ライトノードの照らし方です。次の種類があります。
"Ambient"。環境光ライト。ライトノードのトランスフォームに関わらず、全てのモデルを均等に照らします。
"Directional"。平行ライト。ライトノードの向きと平行に照らします。太陽光と同じ性質です。ノードの位置は関係ありません。
"Point"。ポイントライト。ライトノードの位置から全方位に照らします。光は減衰します。
"Spot"。スポットライト。ライトノードの位置から一定角度で照らします。光は減衰します。

color

color: Color

ライトノードの、光の色、強さです。

spotAngle

spotAngle: Number

ライトノードが照らす角度です。スタイルが "Spot"の場合のみ有効です。

spotDecay

spotDecay: Boolean

ライトノードのスタイルが "Spot"の場合、減衰させるかどうかです。

attenuation

attenuation: Vector

ライトノードの減衰ベクトルです。スタイルが "Point","Spot"の場合のみ有効です。

attenuationX

attenuationX: Number

ライトノードが減衰ベクトルの X座標の値です。

attenuationY

attenuationY: Number

ライトノードが減衰ベクトルの Y座標の値です。

attenuationZ

attenuationZ: Number

ライトノードが減衰ベクトルの Z座標の値です。

specular

specular: Boolean

照らされたモデルノードの光沢を表現するかどうかです。このプロパティを Flaseにするとパフォーマンスが良くなる場合があります。ライトノードのプロパティです。