AdjustAngle Class
Adjustment angle in the shape geometry.
Declaration
public final class AdjustAngle extends Struct<AdjustAngle> implements IEquatable<AdjustAngle>
Remarks
An AdjustAngle instance can store either a numeric angle value or a guide name reference.
Implements
Inherited Members
Inheritance
Constructors
AdjustAngle() Constructor
Initializes a new instance of the AdjustAngle class.
Declaration
public AdjustAngle()
Remarks
The created object has the EMPTY adjustment mode. Use the getIsEmpty() method to determine whether the AdjustAngle instance contains a value.
AdjustAngle(float value) Constructor
Initializes a new instance of the AdjustAngle class with specified settings.
Declaration
public AdjustAngle(float value)
Parameters
| Name | Type | Description |
|---|---|---|
| value | float | The angle in degrees. |
Remarks
The created object has the AdjustmentMode.VALUE adjustment mode.
AdjustAngle(String guideName) Constructor
Initializes a new instance of the AdjustAngle class with specified settings.
Declaration
public AdjustAngle(String guideName)
Parameters
| Name | Type | Description |
|---|---|---|
| guideName | String | The name of the adjustment guide associated with the angle. |
Remarks
The created object has the AdjustmentMode.GUIDE_NAME) adjustment mode.
Fields
EMPTY Field
Gets an empty AdjustAngle instance.
Declaration
public static final AdjustAngle EMPTY
Field Value
| Type | Description |
|---|---|
AdjustAngle |
The empty |
Methods
equals(AdjustAngle other) Method
Determines whether the specified AdjustAngle object is equal to the current AdjustAngle object.
Declaration
public boolean equals(AdjustAngle other)
Parameters
| Name | Type | Description |
|---|---|---|
| other | AdjustAngle |
The |
Returns
| Type | Description |
|---|---|
| boolean |
|
equals(Object obj) Method
Determines whether the specified object is equal to the current AdjustAngle object.
Declaration
public boolean equals(Object obj)
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | The object to compare with the current |
Returns
| Type | Description |
|---|---|
| boolean |
|
getGuideName() Method
Returns the name of the adjustment guide.
Declaration
public String getGuideName()
Returns
| Type | Description |
|---|---|
| String | The guide name. |
getIsEmpty() Method
Indicates whether the AdjustAngle object is empty.
Declaration
public boolean getIsEmpty()
Returns
| Type | Description |
|---|---|
| boolean |
|
getMode() Method
Returns the adjustment mode.
Declaration
public AdjustmentMode getMode()
Returns
| Type | Description |
|---|---|
| AdjustmentMode | The adjustment mode. |
Remarks
The adjustment mode specifies whether AdjustAngle stores:
- a numeric value
- a guide name
- an empty value.
getValue() Method
Returns the angle in degrees.
Declaration
public float getValue()
Returns
| Type | Description |
|---|---|
| float | The angle. |
hashCode() Method
Returns a hash code for the AdjustAngle object.
Declaration
public int hashCode()
Returns
| Type | Description |
|---|---|
| int | The hash code. |