DocumentObject

References

[DebuggerDisplay("{DebuggerDisplay}")] public abstract class DocumentObject : IDocumentObject

Abstract implementation of the IDocumentObject interface for all objects.

Constructors

DocumentObject

protected DocumentObject(IReader reader)

Deserialization constructor.

Parameters:

reader (IReader)

Reader object.

DocumentObject

protected DocumentObject(Nomen nomen)

Base class constructor.

Parameters:

nomen (Nomen)

Object description.

Properties

Activity

public ObjectActivity Activity { get; set; }

Gets or sets the active state of this object. Note that this property is meaningless for certain types of object.

Implements: Activity

Attributes

public IAttributes Attributes { get; }

Gets or sets the attributes for this object.

Implements: Attributes

ChildrenObjects

public virtual IEnumerable<IDocumentObject> ChildrenObjects { get; }

Gets all immediate child objects that belong to the current object. It is possible that an object does not have any children, and it is possible that a child object has children of its own.

Implements: ChildrenObjects

Connectivity

public abstract IObjectConnectivity Connectivity { get; }

Gets the topological connectivity of this object. The topology is not updated automatically, so be sure to get a fresh instance every time you need it.

Implements: Connectivity

CustomValues

public KeyedValues CustomValues { get; }

Gets a collection of keyed values which can be used to store custom data which will survive (de)serialisation.

Implements: CustomValues

Display

public ObjectDisplay Display { get; set; }

Gets or sets the display state of this object. Note that this property is meaningless for certain types of object.

Implements: Display

DisplayCapable

public virtual bool DisplayCapable { get; }

Gets whether this object makes allowance for 3D viewport displays.

Implements: DisplayCapable

DisplayName

public virtual string DisplayName { get; }

Gets the display name of this object. Often the DisplayName is identical to the UserName, but there could be more complicated algorithms involved.

Implements: DisplayName

DisplayStyle

public ObjectDisplayStyle DisplayStyle { get; set; }

Gets or sets the display style to use for the geometric data inside this object. Note that this property is meaningless for certain types of object.

Implements: DisplayStyle

Document

public Document Document { get; set; }

Gets or sets the document this object belongs to. It is possible an object does not belong to any document, however it can never belong to more than one document simultaneously.

Implements: Document

EntireFamily

public IEnumerable<IDocumentObject> EntireFamily { get; }

Enumerates over all objects in the hierarchy this object is part of. This enumeration starts at the root object and then continues over all children and grandchildren in a breadth-first fashion.

Implements: EntireFamily

FoundingObject

public IDocumentObject FoundingObject { get; }

Gets the root or founding object in the object hierarchy. If the current object does not have a parent, it is a founding object.

Implements: FoundingObject

Icon

public IIcon Icon { get; }

Gets the icon associated with this object.

Implements: Icon

IconInternal

protected virtual IIcon IconInternal { get; }

Override this method to provide an icon for this object. If the icon is an embedded resource in this assembly with the same name as the class, it will automatically be loaded. The Icon property calls this property and caches the result.

InstanceId

public Guid InstanceId { get; set; }

Gets or sets the instance Id for this object. The instance Id should be different for every instance of every type. Do *not* assign this Id unless you know exactly what you are doing.

Implements: InstanceId

Nomen

public Nomen Nomen { get; }

Gets the user friendly description of this object.

Implements: Nomen

Obsolete

public bool Obsolete { get; }

Gets whether this object is considered obsolete.

Implements: Obsolete

ParentObject

public IDocumentObject ParentObject { get; set; }

Gets or sets the parent object that owns this object. Top-level objects do not have parents. Do not assign or remove parents unless you know exactly what you are doing.

Implements: ParentObject

Phase

public virtual Phase Phase { get; }

Gets the current solution phase of this object.

Implements: Phase

ProgressPercentage

public int ProgressPercentage { get; }

Gets the progress as a percentage. If this object is currently not calculating a new solution, this number is not meaningful.

Implements: ProgressPercentage

Relevance

public ObjectRelevance Relevance { get; set; }

Gets or sets the auxiliary state of this object. Auxiliary objects are drawn in an inconspicuous way as they are considered in-between logic. Note that this property is meaningless for certain types of object.

Implements: Relevance

Selected

public bool Selected { get; }

Gets the main yes/no state from the SelectionState.

Implements: Selected

Selection

public ObjectSelection Selection { get; set; }

Gets or sets the selected state of this object. Note that the selected setting of secondary objects is inherited from the parent.

Implements: Selection

SharedOptionWidth

protected static int SharedOptionWidth { get; }

Gets the minimum width needed for drawing the widest option label.

SiblingObjects

public IEnumerable<IDocumentObject> SiblingObjects { get; }

Gets all sibling objects in the object family tree.

Implements: SiblingObjects

StandardColourOverrides

public static IEnumerable<(OpenColor.Family family, Color colour)> StandardColourOverrides { get; }

State

public abstract ObjectSolutionState State { get; }

Gets the current solution state of this object.

Implements: State

UserName

public string UserName { get; set; }

Gets the user specified name of this object.

Implements: UserName

Methods

AddUndoRecord

public void AddUndoRecord(Record record)

Add a custom undo record for this object.

Parameters:

record (Record)

Undo record to add.

Returns: Id of undo record.

Implements: AddUndoRecord

AddUndoRecord

public void AddUndoRecord(VerbNoun name, Action action)

Add a single action undo record for this object.

Parameters:

name (VerbNoun)	Name of undo record.
action (Action)	Specific action to undo.

Returns: Id of undo record.

Implements: AddUndoRecord

AppendBakeInput

protected void AppendBakeInput(InputPanel panel)

Append the baking input panel.

Parameters:

panel (InputPanel)

AppendStateInput

protected void AppendStateInput(InputPanel panel, bool enabledState, bool displayState)

Append the 'Enabled' and 'Display' states to this input panel.

Parameters:

panel (InputPanel)	Panel to append to.
enabledState (bool)	If true, the Enabled state button will be modifiable.
displayState (bool)	If true, the Display state button will be modifiable.

AppendToInputPanel

public virtual void AppendToInputPanel(InputPanel panel)

Override this method to populate the popover panel. The base implementation does not add any panel inputs, however the DocumentObject class does provide a slew of protected utility methods for adding standard inputs.

Parameters:

panel (InputPanel)

Implements: AppendToInputPanel

AppendUserNameInput

protected void AppendUserNameInput(InputPanel panel)

Append the user name text box within a category labelled 'Attributes'.

Parameters:

panel (InputPanel)

ChangeInstanceIds

public void ChangeInstanceIds(Dictionary<Guid, Guid> map)

Parameters:

map (Dictionary<Guid, Guid>)

Compute

public abstract SolutionData Compute(Solution solution, CallStack stack)

Compute a new solution for this object, or return a completed solution if one is available.

Parameters:

solution (Solution)	Document solution info.
stack (CallStack)	Call stack leading up to this call.

Returns: Result of computation.

Implements: Compute

CreateAttributes

protected abstract IAttributes CreateAttributes()

Create default attributes for this object. If attributes already exist, this method will not replace them.

DisplayBounds

public virtual BoundingBox DisplayBounds()

Gets the bounds of the geometry this object might display.

Implements: DisplayBounds

DisplayFaces

public virtual void DisplayFaces(DisplayPipeline pipeline, Guises guises, ref BoundingBox extents)

Draw the shaded faces for this object.

Parameters:

pipeline (DisplayPipeline)
guises (Guises)
extents (ref BoundingBox)

Implements: DisplayFaces

DisplayWires

public virtual void DisplayWires(DisplayPipeline pipeline, Guises guises, ref BoundingBox extents)

Draw the wires for this object.

Parameters:

pipeline (DisplayPipeline)
guises (Guises)
extents (ref BoundingBox)

Implements: DisplayWires

Expire

public abstract void Expire()

Expire this object and all objects that depend on it. This will request-cancel any running solutions inside whatever document contains this object.

Implements: Expire

ExpireDisplay

protected void ExpireDisplay()

Expire the attributes and raise the DisplayChanged event.

GetCreationInfo

public bool GetCreationInfo(out string name, out DateTime time)

Gets information about who created this component and when.

Parameters:

name (out string)	Name of creator.
time (out DateTime)	Time of creation in UTC coordinates.

Returns: True if the creation data was available.

Implements: GetCreationInfo

GetModificationInfo

public bool GetModificationInfo(out string name, out DateTime time)

Gets information about who last modified this component and when.

Parameters:

name (out string)	Name of modifier.
time (out DateTime)	Time of modification in UTC coordinates.

Returns: True if the modification data was available.

Implements: GetModificationInfo

InvalidateExistingLayout

protected void InvalidateExistingLayout()

Invalidate the attribute layout, but only if the attributes already exist.

ModifyIcon

public void ModifyIcon(IIcon newIcon, bool overrideExtrinsicIcon = true)

Override the icon for this object. Use this judiciously.

Parameters:

newIcon (IIcon)	New icon to assign, or null to revert to the default icon.
overrideExtrinsicIcon (bool = true)	If true, the permanent extrinsic icon will be overwritten. If false, the temporary intrinsic icon will be overwritten.

Implements: ModifyIcon

ModifyNameAndInfo

public void ModifyNameAndInfo(string name = null, string info = null)

Programmatically modify the nickname, name and/or info strings on the Nomen.

Parameters:

name (string = null)	New name if not null.
info (string = null)	New info if not null.

Implements: ModifyNameAndInfo

OnDisplayChanged

public void OnDisplayChanged()

Raise the DisplayChanged event.

Implements: OnDisplayChanged

OnExpired

protected internal void OnExpired()

Raise the Expired event.

OnLayoutChanged

public void OnLayoutChanged()

Raise the LayoutChanged event.

Implements: OnLayoutChanged

OverrideAttributes

public bool OverrideAttributes(IAttributes attributes)

Assign new attributes to this object. Not all attributes may be accepted, it depends on the implementation.

Parameters:

attributes (IAttributes)

New attributes to assign. Assigning null will revert to default attributes.

Returns: True if attributes were accepted.

Implements: OverrideAttributes

RequestAutoSave

public AutoSaveResult RequestAutoSave(AutoSaveReason reason, Guid autosaveId)

Request an autosave.

Parameters:

reason (AutoSaveReason)	Autosave reason.
autosaveId (Guid)	Autosave Id. Consecutive requests with identical Ids are ignored.

Implements: RequestAutoSave

RequestAutoSave

public AutoSaveResult RequestAutoSave(AutoSaveReason reason)

Request an autosave using the instance ID of this object as a filter. This means hat subsequent autosave requests coming from the same object will be ignored.

Parameters:

reason (AutoSaveReason)

Autosave reason.

Implements: RequestAutoSave

SetCreationInfo

public void SetCreationInfo()

Set the CreatedBy and CreatedAt fields if they haven't been set already.

Implements: SetCreationInfo

SetModificationInfo

public void SetModificationInfo()

Set the ModifiedBy and ModifiedAt fields.

Implements: SetModificationInfo

SetProgressPercentage

public void SetProgressPercentage(int percentage)

Set the ProgressPercentage field directly. The percentage is automatically limited to the [0, 100] interval.

Parameters:

percentage (int)

SetProgressPercentage

public void SetProgressPercentage(long partial, long total)

Set the ProgressPercentage field based on a step count. This method always limits the percentage to the [1, 99] range, as 0% and 100% are oftentimes indicative of unstarted or completed processes, which probably gives the wrong impression.

Parameters: