GetTorus

public class GetTorus : IDisposable
Class provides user interface to define a torus.

Constructors

GetTorus

#Since v7.0
public GetTorus()

Finalizer

~GetTorus

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

Properties

AroundDirectionCount

#Since v7.0
public int AroundDirectionCount { get; set; }
The number of faces in the around direction.

AroundDirectionMinimumCount

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

DefaultSize

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

FixInnerRadius

#Since v7.0
public bool FixInnerRadius { get; set; }
Second radius option. The first radius chosen sets the inner dimension of the torus and the second radius is constrained to be outside of the first radius.

InDiameterMode

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

InSecondDiameterMode

#Since v7.0
public bool InSecondDiameterMode { get; set; }
Second radius option. Determines if the second "size" value is representing a radius or diameter

PromptForMeshDensity

#Since v7.0
public bool PromptForMeshDensity { get; set; }
Set true if you are prompting for a mesh or subd torus.

SecondSize

#Since v7.0
public double SecondSize { get; set; }
Second radius or diameter (based on InSecondDiameterMode)

VerticalDirectionCount

#Since v7.0
public int VerticalDirectionCount { get; set; }
The number of faces in the vertical direction.

VerticalDirectionMinimumCount

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

Methods

Dispose

#Since v7.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.

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

Get

#Since v7.0
public Result Get(out Torus torus)
Prompt for the getting of a torus.
torus (out Torus)The torus geometry defined by the user.
The result of the getting operation.

GetMesh

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