# IRdPhysEnvAttrDisp Interface Reference

Inherits IDispatch.

List of all members.

## Properties
RtBool * | Active`[get]`
RtBool | Active`[set]`
int * | StreamType`[get]`
int | StreamType`[set]`
RtBool * | LocalGravity`[get]`
RtBool | LocalGravity`[set]`
RtFloat * | Atmosphere`[get]`
RtFloat | Atmosphere`[set]`
RtFloat * | Thining`[get]`
RtFloat | Thining`[set]`
VARIANT * | Gravity`[get]`
VARIANT | Gravity`[set]`
VARIANT * | Stream`[get]`
VARIANT | Stream`[set]`
BSTR * | Name`[get]`
BSTR | Name`[set]`

## Detailed Description

IRdPhysEnvAttrDisp interface access to attributes of local environments. It is script version of IRdPhysEnvAttr.

## Property Documentation

RtBool* IRdPhysEnvAttrDisp::Active`[get]`

Return active state of object

Returns:
  pVal [out,retval] Active flag.

RtBool IRdPhysEnvAttrDisp::Active`[set]`

Set active state of object.

Parameters:

  | Val | [in] Active flag.

int* IRdPhysEnvAttrDisp::StreamType`[get]`

Return type of streaming.

Returns:
  pVal [out,retval] Type of stream:
  - Value of 0 means no stream.
  - Value of 1 means classical stream.
  - Value of 2 means cyclone stream (rotation around stream vector).

int IRdPhysEnvAttrDisp::StreamType`[set]`

Set type of streaming.

Parameters:

  | Val | [in] Type of stream Value of 0 means no stream. Value of 1 means classical stream. Value of 2 means cyclone stream (rotation around stream vector).

RtBool* IRdPhysEnvAttrDisp::LocalGravity`[get]`

Return type of local gravity.

Returns:
  pVal [out,retval] Local gravity flag.
  - Value of 0 means that the final gravity is the sum of local and global gravity.
  - Value of 1 means the the final gravity is based only on the local gravity vector.

RtBool IRdPhysEnvAttrDisp::LocalGravity`[set]`

Set type of local gravity.

Parameters:

  | Val | [in] local gravity flag. Value of 0 means that the final gravity is the sum of local and global gravity. Value of 1 means the the final gravity is based only on the local gravity vector.

RtFloat* IRdPhysEnvAttrDisp::Atmosphere`[get]`

Return atmosphere.

Returns:
  pVal [out,retval] Atmosphere value.

RtFloat IRdPhysEnvAttrDisp::Atmosphere`[set]`

Set atmosphere.

Parameters:

  | Val | [in] Atmosphere value.

RtFloat* IRdPhysEnvAttrDisp::Thining`[get]`

Return thining value.

Returns:
  pVal [out,retval] Thining value.

RtFloat IRdPhysEnvAttrDisp::Thining`[set]`

Set thining value.

Parameters:

  | pVal | [in] Thining value.

VARIANT* IRdPhysEnvAttrDisp::Gravity`[get]`

Return gravitation vector.

Returns:
  pVal [out,retval] Gravity vector.

VARIANT IRdPhysEnvAttrDisp::Gravity`[set]`

Set gravitation vector.

Parameters:

  | pVal | [in] Gravity vector.

VARIANT* IRdPhysEnvAttrDisp::Stream`[get]`

Return stream vector.

Returns:
  pVal [out,retval] Stream vector.

VARIANT IRdPhysEnvAttrDisp::Stream`[set]`

Set stream vector.

Parameters:

  | pVal | [in] Stream vector.

BSTR* IRdPhysEnvAttrDisp::Name`[get]`

Return name of environment object.

Returns:
  pVal [out,retval] Name of object.

BSTR IRdPhysEnvAttrDisp::Name`[set]`

Set name of environment object.

Parameters:

  | bstrVal | [in] Name of object.