Class GridLine

Grid lines appear as lines, segments, circles, and arcs of a circle in the model.

Inheritance

object

GridLine

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: DesignData.SDS2.Model

Assembly: DesignData.SDS2.Model.dll

Syntax

public class GridLine

Properties

ArcType

Arc type, only applies for curved grids

Declaration

public ArcType ArcType { get; set; }

Property Value

Type	Description
ArcType

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

DepthIn

The distance in inches from this grid's work plane to a plane farther away than the viewer.

Declaration

public double DepthIn { get; set; }

Property Value

Type	Description
double

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

DepthOut

The distance in inches from this grid's work plane to a plane closer to the viewer.

Declaration

public double DepthOut { get; set; }

Property Value

Type	Description
double

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

GridBubbleOffset

Positive factor by which by which finite grid lines will be extended in proportion to the diameter of its grid bubble.

Declaration

public double GridBubbleOffset { get; set; }

Property Value

Type	Description
double

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

GridType

Grid type

Declaration

public GridType GridType { get; set; }

Property Value

Type	Description
GridType

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

IsAutoPinPermitted

True when the grid line is permitted to be automatically pinned to

Declaration

public bool IsAutoPinPermitted { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

IsForDetail

True when the grid line is allowed for detailing

Declaration

public bool IsForDetail { get; set; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

LineType

Grid line type

Declaration

public LineType LineType { get; set; }

Property Value

Type	Description
LineType

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.

Name

Name of the erection view defined by the grid line

Declaration

public string Name { get; }

Property Value

Type	Description
string

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.

Pen

Grid line pen color

Declaration

public PenColor Pen { get; set; }

Property Value

Type	Description
PenColor

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

Radius

Radius, in inches, of curved grid lines

Declaration

public double Radius { get; set; }

Property Value

Type	Description
double

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

ToGlobalCoordinates

Matrix, in inches, representing a transformation from view coordinates to global coordinates for the grid line

Declaration

public Matrix ToGlobalCoordinates { get; set; }

Property Value

Type	Description
Matrix

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

ToViewCoordinates

Matrix, in inches, representing a transformation from global coordinates to the view coordinates for the grid line

Declaration

public Matrix ToViewCoordinates { get; set; }

Property Value

Type	Description
Matrix

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

ViewBounds2D

2D viewing bounds in view coordinates.

Declaration

public BoundingBox2D ViewBounds2D { get; set; }

Property Value

Type	Description
BoundingBox2D

Remarks

When the model is transformed from global coordinates to view coordinates, only the portion of the model that falls into the area defined by these bounds combined with the depth in and out is visible to the view defined by this gride line.

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

ViewType

The type of view defined by the grid line.

Declaration

public ErectionViewType ViewType { get; set; }

Property Value

Type	Description
ErectionViewType

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.
NotAddedException	Thrown when setting data on the object without having added it to a transaction
NotLockedException	Thrown when reading or writing the property of an object that was added to a transaction but is unlocked

Methods

Dispose(bool)

Grid lines appear as lines, segments, circles, and arcs of a circle in the model.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Equals(object)

Grid lines appear as lines, segments, circles, and arcs of a circle in the model.

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool

Overrides

object.Equals(object)

~GridLine()

Grid lines appear as lines, segments, circles, and arcs of a circle in the model.

Declaration

protected ~GridLine()

Get(GridLineHandle)

Get a GridLine object for the GridLineHandle passed in.

Declaration

public static GridLine Get(GridLineHandle handle)

Parameters

Type	Name	Description
GridLineHandle	handle

Returns

Type	Description
GridLine

GetHashCode()

Grid lines appear as lines, segments, circles, and arcs of a circle in the model.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

IsNearlyPlanView(double)

True when the grid represents a plan view. Specifically, this is when the the viewing direction is within tan_tol of being parallel to vertical in global coordinates. If tan_tol is 0.01745, it tests that the vectors are within approximately 1 degree of parallel.

Declaration

public bool IsNearlyPlanView(double tan_tol)

Parameters

Type	Name	Description
double	tan_tol	The tangent of the angle that specifies the desired tolerance. Note that for small angles x, tan x ~= x, so you can also think of this nearly a tolerance in radians.

Returns

Type	Description
bool

Exceptions

Type	Condition
InvalidValueException	InvalidValueException thrown when the handle is invalid.

RefreshDatabaseTable()

Refresh the the primary table for objects of this type.

Declaration

public static void RefreshDatabaseTable()