Click or drag to resize

Frame Class

Class providing a reference point for visuals using alternate coordinate systems (left-handed or right-handed).
Inheritance Hierarchy
SystemObject
  System.DynamicDynamicObject
    NotifyPropertyChangedBase
      SimpleCustomTypeDescriptor
        GlobalizedProperties
          Demo3D.CommonBindableBase
            Demo3D.VisualsSerializableObject
              Demo3D.Visuals.FramesFrame
                Demo3D.Visuals.FramesVisualFrame

Namespace: Demo3D.Visuals.Frames
Assembly: Demo3D.Core (in Demo3D.Core.dll) Version: 19.01.00
Syntax
C#
public class Frame : SerializableObject

The Frame type exposes the following members.

Constructors
 NameDescription
Public methodFrame Initializes a new instance of the Frame class.
Public methodFrame(FrameCoordinateSystem) Initializes a new instance of the Demo3D.Visuals.Frame class with a specified coordinate system.
Public methodFrame(Frame, FrameCoordinateSystem) Initializes a new instance of the Demo3D.Visuals.Frame class with a parent frame and a specified coordinate system.
Public methodFrame(Visual, FrameCoordinateSystem) Initializes a new instance of the Demo3D.Visuals.Frame class with a parent visual and a specified coordinate system.
Top
Properties
 NameDescription
Public propertyCoordinateSystem The coordinate system used by this frame.
Public propertyEulerConvention The Euler angle convention used by this frame. This applies to the FrameRotation property, but not to the Rotation or WorldRotation properties.
Public propertyFrameLocation The location of this frame, relative to its parent, using the frame's coordinate system.
Public propertyFrameMatrix A matrix representing this frame's location and rotation relative to its parent, using this frame's coordinate system.
Public propertyFrameRotation The rotation of this frame, in degrees, relative to its parent, using this frame's coordinate system and Euler angle convention.
Public propertyId
(Inherited from SerializableObject)
Public propertyLocation The location of this frame, relative to its parent, using the Emulate3D coordinate system.
Public propertyMatrix A matrix representing this frame's location and rotation relative to its parent, using the Emulate3D coordinate system.
Public propertyName The name of this frame.
Public propertyParent This frame's parent frame. This can be null to signify that it has no parent (effectively meaning the scene is the parent). Note that setting the parent doesn't change the Location and Rotation properties, meaning that they will have the same values, but now be relative to the new parent. To reparent while maintaining the same world location and rotation, use the Reparent method.
Public propertyRotation Gets this frame's rotation, in degrees, relative to its parent, using the Emulate3D coordinate system.
Public propertyWorldLocation The location of this frame relative to the scene, using the Emulate3D coordinate system.
Public propertyWorldMatrix A matrix representing this frame's location and rotation relative to the world, using the Emulate3D coordinate system.
Public propertyWorldRotation The rotation of this frame, in degrees, relative to the scene, using the Emulate3D coordinate system.
Top
Methods
 NameDescription
Public methodGetLocationOf Gets the location of another frame, relative to this frame, using this frame's coordinate system.
Public methodGetLocationRelativeTo Gets the location of this frame relative to a reference frame, using that frame's coordinate system.
Public methodGetRotationOf Gets the rotation of another frame, relative to this frame, using this frame's coordinate system.
Public methodGetRotationRelativeTo Gets the rotation in degrees of this frame relative to a reference frame, using that frame's coordinate system.
Public methodRaisePropertiesChanged Raise an PropertyChanged event for each value.
(Inherited from BindableBase)
Public methodRaisePropertyChanged(PropertyChangedEventArgs) Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase)
Public methodRaisePropertyChanged(String) Raise an PropertyChanged event for the specified value.
(Inherited from BindableBase)
Public methodReparent Sets the parent frame to a specified frame, whilst maintaining the same world location and rotation. This is analagous to the reparenting behaviour of visuals.
Public methodSerializableDependency(SerializableObject)
(Overrides SerializableObjectSerializableDependency(SerializableObject))
Obsolete
Public methodSerializableDependency(Visual)
(Overrides SerializableObjectSerializableDependency(Visual))
Obsolete
Protected methodSetINotifyPropertyChangedPropertyT Checks to see if the property is the same as the specified value. It they're different then set the value and raise an PropertyChanged event. Property changes on the new value are also listened to and, if one occurs, the propertyChangedCallback handler will be invoked.
(Inherited from BindableBase)
Protected methodSetPropertyT(T, T, PropertyChangedEventArgs) Checks to see if the property is the same as the specified value. It they're different then set the value and raise an PropertyChanged event.
(Inherited from BindableBase)
Protected methodSetPropertyT(T, T, String) Checks to see if the property is the same as the specified value. It they're different then set the value and raise an PropertyChanged event.
(Inherited from BindableBase)
Public methodToString Returns a string representation of this frame, consisting of the name, prefixed with the name of the owning visual.
(Overrides SimpleCustomTypeDescriptor.ToString)
Top
Events
 NameDescription
Public eventMoved Occurs when the frame's location or rotation changes, either directly or because a parent frame has moved.
Top
Operators
 NameDescription
Public operatorStatic member(Visual to Frame) Automatically constructs a VisualFrame instance from a visual.
Top
See Also