MAXScript Language Reference > 3ds Max Objects > RenderEffect : MAXWrapper > Render Effect Types > Lens Effects >

# Lens_Effects - Ring

    Ring_Element - superclass: ReferenceTarget; super-superclass:MAXWrapper - classID: #(993798577, 1535576468)

Value > MAXWrapper > RenderEffect > LensEffect > Ring_Element

Constructor

    le.addRing <Lens_Effects>

Aliases

    Ring_Element 'Ring Element'

Properties

    <ring>.elementName String default: "Ring" -- alias: Name

    <ring>.on Boolean default: true

    <ring>.size Float default: 75.0 -- animatable

    <ring>.intensity Float default: 75.0 -- animatable

    <ring>.plane Float default: 0.0 -- animatable

    <ring>.thickness Float default: 10.0 -- animatable

    <ring>.objectsHide Boolean default: false -- alias: Object_Hide

    <ring>.occlusion Float default: 100.0 -- animatable

    <ring>.squeeze Boolean default: false

    <ring>.colorSource Float default: 0.0 -- animatable; alias: Source_Color

    <ring>.centerColor Color default: (color 255 255 255) -- animatable; alias: Center_Color

    <ring>.edgeColor Color default: (color 255 0 0) -- animatable; alias: Edge_Color

    <ring>.radialMtl TextureMap default: undefined -- alias: Radial_Material

    <ring>.useRadialMtl Boolean default: false -- alias: Apply_Radial_Color_Map

    <ring>.radial_falloff SubAnim

    <ring>.radialMap TextureMap default: undefined -- alias: Radial_Falloff_Map

    <ring>.useRadialMap Boolean default: false -- alias: Apply_Radial_Falloff_Map

    <ring>.circularColorMix Float default: 0.0 -- animatable; alias: Circular_Color_Mix

    <ring>.quadrant1Color Color default: (color 255 0 0) -- animatable; alias: Quadrant_1_Color

    <ring>.quadrant2Color Color default: (color 255 0 0) -- animatable; alias: Quadrant_2_Color

    <ring>.quadrant3Color Color default: (color 255 0 0) -- animatable; alias: Quadrant_3_Color

    <ring>.quadrant4Color Color default: (color 255 0 0) -- animatable; alias: Quadrant_4_Color

    <ring>.circularMtl TextureMap default: undefined -- alias: Circular_Material

    <ring>.useCircularMtl Boolean default: false -- alias: Apply_Circular_Color_Map

    <ring>.circular_falloff SubAnim

    <ring>.circularMap TextureMap default: undefined -- alias: Circular_Falloff_Map

    <ring>.useCircularMap Boolean default: false -- alias: Apply_Circular_Falloff_Map

    <ring>.radial_size SubAnim

    <ring>.radialSizeMap TextureMap default: undefined -- alias: Radial_Size_Map

    <ring>.useRadialSizeMap Boolean default: false -- alias: Apply_Radial_Size_Map

    <ring>.applyLights Boolean default: true -- alias: Apply_to_Lights

    <ring>.applyImage Boolean default: true -- alias: Apply_to_Image

    <ring>.applyImageCenters Boolean default: false -- alias: Apply_to_Image_Centers

    <ring>.sourceObjectID Boolean default: false -- alias: Source_Object_ID

    <ring>.objectID Integer default: 1 -- animatable; alias: Object_ID

    <ring>.sourceEffectsID Boolean default: false -- alias: Source_Effects_ID

    <ring>.effectsID Integer default: 1 -- animatable; alias: Effects_ID

    <ring>.sourceUnclampedColor Boolean default: false -- alias: Source_Unclamped_Color

    <ring>.unclampedColor Float default: 1.0 -- animatable; alias: Unclamped_Color

    <ring>.unclampedColorInvert Boolean default: false -- alias: Source_Unclamped_Color_Invert

    <ring>.sourceSurfaceNormal Boolean default: false -- alias: Source_Surface_Normal

    <ring>.surfaceNormal Float default: 0.0 -- animatable; alias: Surface_Normal

    <ring>.surfaceNormalInvert Boolean default: false -- alias: Source_Surface_Normal_Invert

    <ring>.sourceWhole Boolean default: false -- alias: Source_Whole

    <ring>.sourceAlpha Boolean default: false -- alias: Source_Alpha

    <ring>.alpha Integer default: 0 -- animatable

    <ring>.sourceZBuffer Boolean default: false -- alias: Source_Z_Buffer

    <ring>.zHi Float default: 1000.0 -- animatable; alias: Z_Hi

    <ring>.zLo Float default: 0.0 -- animatable; alias: Z_Lo

    <ring>.filterAll Boolean default: true -- alias: Filter_All

    <ring>.filterEdge Boolean default: false -- alias: Filter_Edge

    <ring>.filterPerimeterAlpha Boolean default: false -- alias: Filter_Perimeter_Alpha

    <ring>.filterPerimeter Boolean default: false -- alias: Filter_Perimeter

    <ring>.filterBrightness Boolean default: false -- alias: Filter_Brightness

    <ring>.brightness Integer default: 0 -- animatable; alias: Bright

    <ring>.brightnessInvert Boolean default: false -- alias: Filter_Brightness_Invert

    <ring>.filterHue Boolean default: false -- alias: Filter_Hue

    <ring>.hueRange Integer default: 0 -- animatable; alias: Hue_Range

    <ring>.hue Color default: (color 255 0 0) -- animatable

    <ring>.applyNoise Boolean default: false -- alias: Apply_Additional_Effects

    <ring>.noiseMap TextureMap default: undefined -- alias: Noise_Map

    <ring>.radial_density SubAnim

    <ring>.radialDensity TextureMap default: undefined -- alias: Radial_Density_Map

    <ring>.useRadialDensity Boolean default: false -- alias: Apply_Radial_Density_Map

    <ring.radial_falloff>.curve_1 SubAnim

The curve_1 SubAnim contains the radial_falloff curve. You cannot create or access points in this curve unless the point is animated. In this case, you can access the animated point position as a SubAnim of the curve_1 property.

    <ring.circular_falloff>.curve_1 SubAnim

The curve_1 SubAnim contains the circular_falloff curve. You cannot create or access points in this curve unless the point is animated. In this case, you can access the animated point position as a SubAnim of the curve_1 property.

    <ring.radial_size>.curve_1 SubAnim

The curve_1 SubAnim contains the radial_size curve. You cannot create or access points in this curve unless the point is animated. In this case, you can access the animated point position as a SubAnim of the curve_1 property.

    <ring.radial_density>.curve_1 SubAnim

The curve_1 SubAnim contains the radial_density curve. You cannot create or access points in this curve unless the point is animated. In this case, you can access the animated point position as a SubAnim of the curve_1 property.

NoteThe le.addRing <Lens_Effects> method returns true if the addition was successful, false if it failed. Once the element has been added, it can be accessed as a property of the lens_effects value. The name of this property for ring elements is ring . If more than one element of the same type is added, only the first is accessible using the property name. You will need to access the remaining elements as subAnims of the lens_effects value. The subAnim names are the same as the property names. The elements start at subAnim 7.

#### See Also

- Lens_Effects : RenderEffect

- Value Common Properties, Operators, and Methods