PlaneCommand Constructor(LeadPoint,int,int,int,int,int,int,int,int,int,RasterColor,RasterColor,PlaneCommandFlags)

Summary

Initializes a new PlaneCommand class object with explicit parameters.

Syntax

C++/CLI

Python

public PlaneCommand( 
   LeadPoint centerPoint, 
   int zValue, 
   int distance, 
   int planeOffset, 
   int repeat, 
   int pyramidAngle, 
   int stretch, 
   int startBright, 
   int endBright, 
   int brightLength, 
   RasterColor brightColor, 
   RasterColor fillColor, 
   PlaneCommandFlags flags 
)

public: 
PlaneCommand(  
   LeadPoint centerPoint, 
   int zValue, 
   int distance, 
   int planeOffset, 
   int repeat, 
   int pyramidAngle, 
   int stretch, 
   int startBright, 
   int endBright, 
   int brightLength, 
   RasterColor brightColor, 
   RasterColor fillColor, 
   PlaneCommandFlags flags 
)

__init__(self,centerPoint,zValue,distance,planeOffset,repeat,pyramidAngle,stretch,startBright,endBright,brightLength,brightColor,fillColor,flags) # Overloaded constructor

Parameters

centerPoint
Contains the point at which the camera or viewer is looking. This is also the point toward which the images will be bent. It may be outside the image borders.

zValue
Viewing screen offset on the Z-axis, in pixels.

distance
Camera distance from the viewing screen, in pixels.

planeOffset
Distance between the parallel planes. This property only accepts positive values.

repeat
Number of times the image repeats along the Z-axis. If repeat equals -1 the image will be infinitely repeated. Its range starts from -1.

pyramidAngle
The view angle, off the Z-axis. This value is given in hundredths of a degree (+/-). This can be a number from 0 to 36,000.

stretch
Value that indicates whether to expand or compress the image, and by how much. If Stretch < 100 image will be expanded. If Stretch > 100 the image will be compressed. Use 100 to maintain the image's dimensions. The value of this parameter is internally divided by 100. This parameter only accepts positive values.

startBright
Value that indicates the brightness of an external light source on the first image displayed. Possible values range from 0 to 100. A value of 0 indicates no external light displayed on the image. A value of 100 indicates an external light source with full brightness is displayed on the image.

endBright
Value that indicates the brightness of an external light source on the last image displayed. Possible values range from 0 to 100. A value of 0 indicates no external light displayed on the image. A value of 100 indicates an external light source with full brightness is displayed on the image.

brightLength
Value that indicates how much the brightness changes as you move along the Z axis. This property is internally multiplied by 50.

brightColor
Specifies the color of an external light source that shines on the displayed images.

fillColor
Specifies the background color.

flags
Flags that indicate the background color and the planes to be shown. You can use a bit wise OR ( ¦ ) to specify one flag from each group.

Example

Run the PlaneCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
 
public void PlaneConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "sample5.cmp")); 
 
   // Prepare the command 
   PlaneCommand command = new PlaneCommand(new LeadPoint(image.Width / 2, image.Height / 2), 0, image.Height, image.Width / 2, -1, 0, 25, 0, 100, 20000, new RasterColor(255, 255, 255), new RasterColor(0, 0, 0), 
         PlaneCommandFlags.Right | PlaneCommandFlags.Left | PlaneCommandFlags.Color); 
   command.Run(image); 
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24); 
 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

Requirements

Target Platforms

Reference

PlaneCommand Class

PlaneCommand Members

Overload List

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.ImageProcessing.SpecialEffects Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.SpecialEffects Namespace

Assemblies