Objects - Lights

VectorScript Declaration:

FUNCTION ContainsLight

( containerObject:HANDLE ) :BOOLEAN ;

Python:

def vs.ContainsLight(containerObject):
return BOOLEAN

Description:

Function ContainsLight returns TRUE if the referenced object contains a light. This function works with container objects such as groups, symbols, layers, etc.

説明

ハンドルで指定したコンテナ（グループ、シンボル、レイヤ）内に光源が含まれている場合はTRUEを返します。

Parameters:

containerObject Handle to object. コンテナのハンドル

CreateLight

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

FUNCTION CreateLight

( pXR :REAL;

pYR :REAL;

pZR :REAL;

lightType :INTEGER;

isOn :BOOLEAN;

castShadow :BOOLEAN

) :HANDLE ;

Python:

def vs.CreateLight(pXR, pYR, pZR, lightType, isOn, castShadow):
return HANDLE

Description:

CreateLight creates a new light object in the active VectorScript document.

A new light objects' color is defaulted to white, and brightness is defaulted to 75%.

Table - Light Types

Light Type Constant

Directional 0

Point 1

Spot 2

説明

座標を指定して光源を作成し、そのハンドルを返します。

Parameters:

pXR X coordinate of new light. 光源のX座標

pYR Y coordinate of new light. 光源のY座標

pZR Z coordinate of new light. 光源のZ座標

lightType Light type. 光源の種類

isOn On-off status of light. 光源のスイッチ（TRUE=ON）

castShadow Specifies whether light will cast shadow. 影の有無

Example:
CreateLight(2,3,8,1,TRUE,TRUE);

Light Type	Constant
Directional	0
Point	1
Spot	2

GetBeamAngle

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE GetBeamAngle

( h :HANDLE;

VAR beamAngleR :REAL

) ;

Python:

def vs.GetBeamAngle(h):
return beamAngleR

Description:

Procedure GetBeamAngle returns the spread angle of the referenced spot light.

説明

ハンドルで指定した光源（スポットライト）の光束の角度を返します。

Parameters:

h Handle to light. 光源（スポットライト）のハンドル

beamAngleR Returns beam spread angle. 光源の光束の角度

GetLayerAmbientColor

Objects - Lights
VectorWorks8.0

VectorScript Declaration:

PROCEDURE GetLayerAmbientColor

( layer :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetLayerAmbientColor(layer):
return (red, green, blue)

Description:

Procedure GetLayerAmbientColor returns the color of the ambient light of the referenced layer. RGB values are in the range of 0~65535.

説明

ハンドルで指定したレイヤの背景放射光の色成分を返します。値の範囲は0から65535までです。

Parameters:

layer Handle to layer. レイヤのハンドル

red Returns RGB color component value. 赤の成分

green Returns RGB color component value. 緑の成分

blue Returns RGB color component value. 青の成分

GetLayerAmbientInfo

Objects - Lights
VectorWorks8.0

VectorScript Declaration:

PROCEDURE GetLayerAmbientInfo

( layer :HANDLE;

VAR isOn :BOOLEAN;

VAR brightness :INTEGER

) ;

Python:

def vs.GetLayerAmbientInfo(layer):
return (isOn, brightness)

Description:

Procedure GetLayerAmbientInfo returns the attribute values for the ambient light object of the referenced layer.

説明

ハンドルで指定したレイヤの背景放射光の情報（スイッチ、明るさ）を返します。

Parameters:

layer Handle to layer. レイヤのハンドル

isOn On-off status of ambient light. スイッチ

brightness Brightness of ambient light. 明るさ

GetLightColorRGB

Objects - Lights
MiniCAD7.0.1

VectorScript Declaration:

PROCEDURE GetLightColorRGB

( light :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetLightColorRGB(light):
return (red, green, blue)

Description:

Procedure GetLightColorRGB returns the RGB color values for the referenced light object.

説明

ハンドルで指定した光源の放射光の色成分を返します。

Parameters:

light Handle to light. 光源のハンドル

red Returns RGB color component value. 赤の成分

green Returns RGB color component value. 緑の成分

blue Returns RGB color component value. 青の成分

GetLightDirection

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE GetLightDirection

( h :HANDLE;

VAR panAngleR :REAL;

VAR tiltAngleR :REAL

) ;

Python:

def vs.GetLightDirection(h):
return (panAngleR, tiltAngleR)

Description:

Procedure GetLightDirection returns the direction angles of the referenced light object.

説明

ハンドルで指定した光源の、パン角度（パノラマ上の開き）と傾きを返します。

Parameters:

h Handle to light. 光源のハンドル

panAngleR Returns light pan angle. 光源のパン角度

tiltAngleR Returns light tilt angle. 光源の傾き

GetLightFalloff

Objects - Lights
MiniCAD7.0.1

VectorScript Declaration:

PROCEDURE GetLightFalloff

( light :HANDLE;

VAR distFalloff :INTEGER;

VAR angFalloff :INTEGER

) ;

Python:

def vs.GetLightFalloff(light):
return (distFalloff, angFalloff)

Description:

Procedure GetLightFalloff returns the fall off attributes for the referenced light object.

Table - Light Falloff Types

Falloff Type Constant

None 0

Normal 1

Smooth 2

Sharp 3

説明

ハンドルで指定した光源の、減衰距離と減衰角度を返します。

Parameters:

light Handle to light. 光源のハンドル

distFalloff Returns distance falloff value. 減衰距離

angFalloff Returns angular falloff value. 減衰角度

Falloff Type	Constant
None	0
Normal	1
Smooth	2
Sharp	3

GetLightInfo

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE GetLightInfo

( h :HANDLE;

VAR lightType :INTEGER;

VAR brightness :INTEGER;

VAR isOn :BOOLEAN;

VAR castShadow :BOOLEAN

) ;

Python:

def vs.GetLightInfo(h):
return (lightType, brightness, isOn, castShadow)

Description:

Procedure GetLightInfo returns the attributes of the referenced light object.

Table - Light Types

Light Type Constant

Directional 0

Point 1

Spot 2

説明

ハンドルで指定した光源の情報を返します。

Parameters:

h Handle to light. 光源のハンドル

lightType Returns light type. 光源の種類

brightness Returns light brightness. 光源の明るさ

isOn Returns on-off status of light. 光源のスイッチ（TRUE=ON）

castShadow Returns whether light casts shadows. 影の有無

GetLightLocation

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE GetLightLocation

( h :HANDLE;

VAR pX :REAL;

VAR pY :REAL;

VAR pZ :REAL

) ;

Python:

def vs.GetLightLocation(h):
return p

Description:

Procedure GetLightLocation returns the position of the referenced light object.

説明

ハンドルで指定した光源の位置を座標で返します。

Parameters:

h Handle to light. 光源のハンドル

p Returns coordinate location of light. 光源の座標

GetSpreadAngle

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE GetSpreadAngle

( h :HANDLE;

VAR spreadAngleR :REAL

) ;

Python:

def vs.GetSpreadAngle(h):
return spreadAngleR

Description:

Procedure GetSpreadAngle returns the spread angle of the referenced spot light.

説明

ハンドルで指定した光源（スポットライト）の拡散光の角度を返します。

Parameters:

h Handle to light. 光源（スポットライト）のハンドル

spreadAngleR Returns spread angle of light. 光源の拡散光の角度

SetBeamAngle

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE SetBeamAngle

( h :HANDLE;

beamAngleR :REAL

) ;

Python:

def vs.SetBeamAngle(h, beamAngleR):
return None

Description:

Procedure SetBeamAngle sets the spread angle of the referenced spot light.

説明

ハンドルで指定した光源（スポットライト）の光束の角度を設定します。

Parameters:

h Handle to light. 光源（スポットライト）のハンドル

beamAngleR Beam angle of light. 光源の光束の角度

SetLayerAmbientColor

Objects - Lights
VectorWorks8.0

VectorScript Declaration:

PROCEDURE SetLayerAmbientColor

( layer :HANDLE;

red :LONGINT;

green :LONGINT;

blue :LONGINT

) ;

Python:

def vs.SetLayerAmbientColor(layer, red, green, blue):
return None

Description:

Procedure SetLayerAmbientColor sets the color for the ambient light of the referenced layer. RGB values are in the range of 0~65535.

説明

ハンドルで指定したレイヤの背景放射光の色成分を設定します。値の範囲は0から65535までです。

Parameters:

layer Handle to layer. レイヤのハンドル

red RGB color component value. 赤の成分

green RGB color component value. 緑の成分

blue RGB color component value. 青の成分

SetLayerAmbientInfo

Objects - Lights
VectorWorks8.0

VectorScript Declaration:

PROCEDURE SetLayerAmbientInfo

( layer :HANDLE;

isOn :BOOLEAN;

brightness :INTEGER

) ;

Python:

def vs.SetLayerAmbientInfo(layer, isOn, brightness):
return None

Description:

Procedure SetLayerAmbientInfo sets the attribute values for the ambient light object of the referenced layer.

説明

ハンドルで指定したレイヤの背景放射光の情報（スイッチ、明るさ）を設定します。

Parameters:

layer Handle to layer. レイヤのハンドル

isOn On-off status of ambient light スイッチ

brightness Brightness of ambient light. 明るさ

SetLightColorRGB

Objects - Lights
MiniCAD7.0.1

VectorScript Declaration:

PROCEDURE SetLightColorRGB

( light :HANDLE;

red :LONGINT;

green :LONGINT;

blue :LONGINT

) ;

Python:

def vs.SetLightColorRGB(light, red, green, blue):
return None

Description:

Procedure SetLightColorRGB sets the RGB color values for the referenced light object.

説明

ハンドルで指定した光源が放射する光の色を設定します。

Parameters:

light Handle to light. 光源のハンドル

red RGB color component value. 赤の成分

green RGB color component value. 緑の成分

blue RGB color component value. 青の成分

SetLightDirection

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE SetLightDirection

( h :HANDLE;

panAngleR :REAL;

tiltAngleR :REAL

) ;

Python:

def vs.SetLightDirection(h, panAngleR, tiltAngleR):
return None

Description:

Procedure SetLightDirection sets the direction angles of the referenced light object.

説明

ハンドルで指定した光源のパン角度（パノラマ上の開き）と傾きを設定します。

Parameters:

h Handle to light. 光源のハンドル

panAngleR Pan angle of light. 光源のパン角度

tiltAngleR Tilt angle of light. 光源の傾き

SetLightFalloff

Objects - Lights
MiniCAD7.0.1

VectorScript Declaration:

PROCEDURE SetLightFalloff

( light :HANDLE;

distFalloff :INTEGER;

angFalloff :INTEGER

) ;

Python:

def vs.SetLightFalloff(light, distFalloff, angFalloff):
return None

Description:

Procedure SetLightFalloff sets the fall off attributes for the referenced light object.

Table - Light Falloff Types

Falloff Type Constant

None 0

Normal 1

Smooth 2

Sharp 3

説明

ハンドルで指定した光源の、減衰距離と減衰角度を設定します。

Parameters:

light Handle to light. 光源のハンドル

distFalloff Distance falloff value. 減衰距離

angFalloff Angular falloff value. 減衰角度

SetLightInfo

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE SetLightInfo

( h :HANDLE;

lightType :INTEGER;

brightness :INTEGER;

isOn :BOOLEAN;

castShadow :BOOLEAN

) ;

Python:

def vs.SetLightInfo(h, lightType, brightness, isOn, castShadow):
return None

Description:

Sets the attributes of the referenced light object.

説明

ハンドルで指定した光源の情報を設定します。

Parameters:

h Handle to light. 光源のハンドル

lightType Light type. 光源の種類

brightness Brightness of light. 光源の明るさ

isOn On-off status of light. 光源のスイッチ（TRUE=ON）

castShadow Shadow casting status of light. 影の有無

SetLightLocation

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE SetLightLocation

( h :HANDLE;

pX :REAL;

pY :REAL;

zValue :REAL

) ;

Python:

def vs.SetLightLocation(h, p, zValue):
return None

Description:

Procedure SetLightLocation sets the location of the referenced light object.

説明

ハンドルで指定した光源の位置を設定します。

Parameters:

h Handle to light. 光源のハンドル

p X-Y coordinate location of light. 光源のX、Y座標

zValue Elevation of light. 光源のZ座標

SetSpreadAngle

Objects - Lights
MiniCAD7.0

VectorScript Declaration:

PROCEDURE SetSpreadAngle

( h :HANDLE;

spreadAngleR :REAL

) ;

Python:

def vs.SetSpreadAngle(h, spreadAngleR):
return None

Description:

Procedure SetSpreadAngle sets the spread angle of the light object. If the light type is not a spot light, the procedure has no effect on the light.

説明

ハンドルで指定した光源（スポットライト）の拡散光の角度を設定します。

Parameters:

h Handle to light. 光源（スポットライト）のハンドル

spreadAngleR Beam spread angle of light. 光源の拡散光の角度

pXR	X coordinate of new light.	光源のX座標
pYR	Y coordinate of new light.	光源のY座標
pZR	Z coordinate of new light.	光源のZ座標
lightType	Light type.	光源の種類
isOn	On-off status of light.	光源のスイッチ（TRUE=ON）
castShadow	Specifies whether light will cast shadow.	影の有無

h	Handle to light.	光源（スポットライト）のハンドル
beamAngleR	Returns beam spread angle.	光源の光束の角度

layer	Handle to layer.	レイヤのハンドル
red	Returns RGB color component value.	赤の成分
green	Returns RGB color component value.	緑の成分
blue	Returns RGB color component value.	青の成分

light	Handle to light.	光源のハンドル
red	Returns RGB color component value.	赤の成分
green	Returns RGB color component value.	緑の成分
blue	Returns RGB color component value.	青の成分

h	Handle to light.	光源のハンドル
panAngleR	Returns light pan angle.	光源のパン角度
tiltAngleR	Returns light tilt angle.	光源の傾き

h	Handle to light.	光源のハンドル
p	Returns coordinate location of light.	光源の座標

h	Handle to light.	光源（スポットライト）のハンドル
spreadAngleR	Returns spread angle of light.	光源の拡散光の角度

h	Handle to light.	光源のハンドル
p	X-Y coordinate location of light.	光源のX、Y座標
zValue	Elevation of light.	光源のZ座標