GetTorus

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

Constructors

GetTorus

#Since v7.0
public GetTorus()

Finalizer

~GetTorus

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

Properties

AroundDirectionCount

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

AroundDirectionMinimumCount

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

DefaultSize

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

FixInnerRadius

#Since v7.0
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.
public bool FixInnerRadius { get; set; }

InDiameterMode

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

InSecondDiameterMode

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

PromptForMeshDensity

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

SecondSize

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

VerticalDirectionCount

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

VerticalDirectionMinimumCount

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

Methods

Dispose

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

Dispose

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

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

Get

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

GetMesh

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