IPortalFrame Interface

Represents a portal frame

Namespace: TSD.API.Remoting.PortalFrames
Assembly: TSD.API.Remoting (in TSD.API.Remoting.dll) Version:
public interface IPortalFrame : IEntity, 
	IHaveId, IHaveIndex, IHaveName, IHaveUserDefinedAttributes

The IPortalFrame type exposes the following members.

Public propertyAutoDesign Gets a value indicating whether this portal frame is auto-designed
Public propertyConstructionPlaneInfo Gets the EntityInfo of the IConstructionPlane the portal frame is constructed in
Public propertyElementGroupName Gets the name of the element group
(Inherited from IEntity)
Public propertyEntityType Gets the type of the entity
(Inherited from IEntity)
Public propertyId Gets the ID
(Inherited from IHaveId)
Public propertyIndex Gets the index
(Inherited from IHaveIndex)
Public propertyName Gets the name
(Inherited from IHaveName)
Public propertyOffset Gets the offset of the portal frame from the plane origin
Public propertyOrientationFactor Gets the orientation factor for the x-axis of the portal frame relative to the plane (either +1 or -1)
Public propertyPlane Gets the IPlane the portal frame is constructed in
Public propertyReferenceConstructionPointIndices Gets the indices of reference IConstructionPoints of the portal frame
Public propertySpanCount Gets the number of spans
Public propertyValleyCount Gets the number of valleys
Public methodGetSpanAsync Returns the spans from the given indices
Public methodGetUserDefinedAttributesAsync Returns a collection of IUserDefinedAttribute instances
(Inherited from IHaveUserDefinedAttributes)
Public methodGetValleyAsync Returns the valleys from the given indices
Public methodSetUserDefinedAttributeAsync Sets an user defined text attribute
(Inherited from IHaveUserDefinedAttributes)
Public methodSetUserDefinedAttributesAsync Sets user defined attributes
(Inherited from IHaveUserDefinedAttributes)
Public methodSetUserDefinedEmbeddedFileAttributeAsync Sets an user defined embedded file attribute
(Inherited from IHaveUserDefinedAttributes)
See Also
Was this helpful?
The feedback you give here is not visible to other users. We use your comments to improve the content.