GetCylinder

public class GetCylinder : IDisposable
Class provides user interface to define a cylinder.

Constructors

GetCylinder

#Since v6.0
public GetCylinder()

Finalizer

~GetCylinder

#
~GetCylinder()
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

Properties

AroundDirectionMinimumCount

#Since v9.0
public int AroundDirectionMinimumCount { get; set; }
The minimum number of faces in the around direction.

BothSidesOption

#Since v6.0
public bool BothSidesOption { get; set; }
Determine if the "both sides" option is enabled

Cap

#Since v6.0
public bool Cap { get; set; }
Gets or sets whether or not the output should be capped.

CylinderConstraint

#Since v6.0
public CylinderConstraint CylinderConstraint { get; set; }
State of the cone/cylinder constraint option. When the cone/cylinder option is selected, the circle is being made as a base for a cone/cylinder. By default the vertical cone/cylinder option not available but is not selected. By default the "Vertical" option applies to VerticalCircle.

DefaultSize

#Since v6.0
public double DefaultSize { get; set; }
Default radius or diameter (based on InDiameterMode)

Height

#Since v6.0
public double Height { get; set; }
Height of cylinder

InDiameterMode

#Since v6.0
public bool InDiameterMode { get; set; }
Determines if the "size" value is representing a radius or diameter

VerticalDirectionMinimumCount

#Since v9.0
public int VerticalDirectionMinimumCount { get; set; }
The minimum number of faces in the vertical direction.

Methods

Dispose

#Since v6.0
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.

Dispose

#
protected virtual void Dispose(bool disposing)
For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

Parameters:
disposing (bool)true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.

Get

#Since v6.0
public Result Get(out Cylinder cylinder)
Prompt for the getting of a cylinder.
Parameters:
cylinder (out Cylinder)The cylinder geometry defined by the user.
Returns: The result of the getting operation.

Get

#Since v6.0
public Result Get(out Extrusion cylinder)
Prompt for the getting of a cylinder.
Parameters:
cylinder (out Extrusion)The cylinder geometry defined by the user.
Returns: The result of the getting operation.

GetMesh

#Since v7.0
public Result GetMesh(ref int verticalFaces, ref int aroundFaces, out Cylinder cylinder)
Prompt for the getting of a mesh cylinder.
Parameters:
verticalFaces (ref int)The number of faces in the vertical direction.
aroundFaces (ref int)The number of faces in the around direction
cylinder (out Cylinder)The cylinder geometry defined by the user.
Returns: The result of the getting operation.

GetMesh

#Since v7.0
public Result GetMesh(ref int verticalFaces, ref int aroundFaces, ref int capStyle, out Cylinder cylinder)
Prompt for the getting of a mesh cylinder.
Remarks: The prompt for capStyle will only be seen if it's not zero, aroundFaces is even and the solid option is on.
Parameters:
verticalFaces (ref int)The number of faces in the vertical direction.
aroundFaces (ref int)The number of faces in the around direction
capStyle (ref int)Set to 0 if you don't want the prompt, 3 is triangles, 4 is quads.
cylinder (out Cylinder)The cylinder geometry defined by the user.
Returns: The result of the getting operation.