Class PickerGeneral

Namespace: VM.Managed.Picker.Core
Assembly: VMAppCore.dll

This class is to represent the general entity picker.

public abstract class PickerGeneral : PickerBase

Inheritance

object ← PickerBase ← PickerGeneral

Inherited Members

PickerBase.raise_CustomFilterEvent(object, FilterArgs), PickerBase.Pick(bool), PickerBase.PickWithStartSignal(bool, ManualResetEvent), PickerBase.Abort(), PickerBase.GetPickerInfo(), PickerBase.GetValidResultXml(string), PickerBase.GetResultXmlFromKey(UIntPtr), PickerBase.GetChangeNoneParametricXml(string), PickerBase.Filtering(UIntPtr), PickerBase.FilteringVMPID(_VM_ID), PickerBase.FilteringAnother(UIntPtr), PickerBase.FilteringReference(UIntPtr, UIntPtr), PickerBase.Highlight(bool), PickerBase.GetAdjacentPatch(double, List), PickerBase.UseEntityFiltering(), PickerBase.SetResultImpl(ref string, bool), PickerBase.UpdateDisplay(), PickerBase.ActiveDocument, PickerBase.IsOnlyResultXml, PickerBase.IsReference, PickerBase.SymmetricType, PickerBase.ResultXml, PickerBase.Result, PickerBase.CustomFilterEvent

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects(object, LinkPropertyType)

Constructors

PickerGeneral(ICollection)

public PickerGeneral(ICollection<type> arTypes)

Parameters

arTypes ICollectionType>

PickerGeneral(Type, bool)

Initializes a new instance of the class

public PickerGeneral(Type type, bool bIsInterface)

Parameters

type Type

The type of entity for pick.

bIsInterface bool

Whether interface or not.

Properties

AllowChildSubsystem

Get the flag of picking the reference objects.

public bool AllowChildSubsystem { get; set; }

Property Value

bool

PickableTypes

Get array of pickable type.

public Type[] PickableTypes { get; }

Property Value

Type[]

Methods

ConvertKeyToInstanceContainerImpl(ObjectBase)

protected abstract UIntPtr ConvertKeyToInstanceContainerImpl(ObjectBase obj)

Parameters

obj ObjectBase

Returns

UIntPtr

Filtering(UIntPtr)

Filtering to not proper object.

public override bool Filtering(UIntPtr pTarget)

Parameters

pTarget UIntPtr

Filtering target.

Returns

bool

true if success; otherwise, false.

FilteringReference(UIntPtr, UIntPtr)

Filtering to not proper object about special target into owner.

public override bool FilteringReference(UIntPtr pOwner, UIntPtr pTarget)

Parameters

pOwner UIntPtr

Filtering owner of target.

pTarget UIntPtr

Filtering target.

Returns

bool

true if success; otherwise, false.

GetBodyImpl(UIntPtr, bool)

protected abstract ObjectBase GetBodyImpl(UIntPtr pKey, bool bIgnoreMarker)

Parameters

pKey UIntPtr

bIgnoreMarker bool

Returns

ObjectBase

GetPickerInfo()

Gets information of picking type.

public override string GetPickerInfo()

Returns

string

GetResultXmlFromKey(UIntPtr)

Get valid result xml according to picker key of core.

public override string GetResultXmlFromKey(UIntPtr key)

Parameters

key UIntPtr

Picking destination key.

Returns

string

The valid result xml.

Highlight(bool)

Picking highlight to filtered target.

public override void Highlight(bool bHighlight)

Parameters

bHighlight bool

If set to ture is highlight; otherwise, false isn't highlight.

HighlightCurveset(ObjectBase, bool)

protected void HighlightCurveset(ObjectBase obj, bool bHighlight)

Parameters

obj ObjectBase

bHighlight bool

HighlightFaceset(ObjectBase, bool)

protected void HighlightFaceset(ObjectBase obj, bool bHighlight)

Parameters

obj ObjectBase

bHighlight bool

HighlightGeometry(ObjectBase, bool)

protected void HighlightGeometry(ObjectBase obj, bool bHighlight)

Parameters

obj ObjectBase

bHighlight bool

HighlightImpl(ObjectBase, bool)

protected abstract bool HighlightImpl(ObjectBase obj, bool bHighlight)

Parameters

obj ObjectBase

bHighlight bool

Returns

bool

HighlightInstanceContainer(ObjectBase, bool)

protected void HighlightInstanceContainer(ObjectBase obj, bool bHighlight)

Parameters

obj ObjectBase

bHighlight bool

HighlightOpenDesigner(ObjectBase, bool)

protected void HighlightOpenDesigner(ObjectBase obj, bool bHighlight)

Parameters

obj ObjectBase

bHighlight bool

HighlightReferenceFaceset(ObjectBase, bool, bool)

protected void HighlightReferenceFaceset(ObjectBase obj, bool bHighlight, bool bUpdate)

Parameters

obj ObjectBase

bHighlight bool

bUpdate bool

IsAcceptedPickAndModifiedTargetObject(ref ObjectBase)

Picked object should be include setted interface.

public bool IsAcceptedPickAndModifiedTargetObject(ref ObjectBase obj)

Parameters

obj ObjectBase

The picked object.

Returns

bool

true if accepted; otherwise, false.

SetResultImpl(ref string, bool)

Sets the result for picking.

protected override bool SetResultImpl(ref string strXml, bool bXmlOnly)

Parameters

strXml string

The picked data.

bXmlOnly bool

If it is true, skip the result setting.

Returns

bool

true if success; otherwise, false.