"RevitAPIIFC"

Get the local file name, including the path, corresponding to a linked IFC file. This will create a local copy of the IFC file if necessary.

The document that will contain the IFC link. The original file name and path. The local file name and path corresponding to the input file name. Can't process file name. A non-optional argument was NULL 2018

Creates an empty family of a given category.

The importer. The document to create the family. The category id. The family name. The created family id. A non-optional argument was NULL 2014

A class that contains utilities needed to implement Revit's version of the IFC import client application.

This class contains special API utilities needed to enable the implementation of the client application for IFC import. Some of these utilities will be needed temporarily while the code for IFC import is migrated into the export client. These temporary interfaces are likely to change in upcoming Revit releases. 2014

Gets the representation handles created representing the processed geometry and stored in this object.

The collection of representation handles. 2013

Gets the IfcFace handles created representing the processed geometry and stored in this object.

The collection of face handles. 2012

Gets the IfcSurface handles created representing the processed geometry and stored in this object.

The collection of surface handles. 2012

Gets the IfcCurve handles created representing the processed geometry and stored in this object.

The collection of curve handles. 2012

Creates a new container object which holds IfcFace handles processed from a Revit geometry object.

The exporter. The plane in which the face handles must lie. The normal vector to the input plane. The epsilon value used to process surfaces. Indicates if this should also create geometry representation handles. The new geometry info container. A non-optional argument was NULL 2013

Creates a new container object which holds IfcFace handles processed from a Revit geometry object.

The epsilon value used to process surfaces. Indicates whether we should use a coarse representation. The new geometry info container. 2013

Creates a new container object which holds IfcFace handles processed from a Revit geometry object.

The epsilon value used to process surfaces. The new geometry info container. 2012

Creates a new container object which holds IfcSurface handles processed from a Revit geometry object.

The epsilon value used to process surfaces. The new geometry info container. 2012

Creates a new container object which holds IfcCurve handles processed from a Revit geometry object.

The exporter. The local coordinate system that defines the plane in which the curve handles must lie. The normal vector to the input plane. True to match curves with plan view visibility only, false to match curves regardless of their plan view visibility. The new geometry info container. A non-optional argument was NULL 2017

Specifies whether the .NET object represents a valid Revit entity.

If the corresponding Revit native object is destroyed, or creation of the corresponding object is undone, a managed API object containing it is no longer valid. API methods cannot be called on invalidated wrapper objects. True if the API object holds a valid Revit native object, false otherwise. 2014

A container class for Revit geometry extracted from an element.

2012

Adds a string value to a built-in parameter.

The element. The built-in parameter id. The new value. A non-optional argument was NULL 2013

Sets the handles representing the cardinal directions in 2D.

True if the handles returned should be in the positive direction, false if the handles should be in the negative direction. The X direction handle. The Y direction handle. A non-optional argument was NULL 2013

Sets the handles representing the cardinal directions in 3D.

True if the handles returned should be in the positive direction, false if the handles should be in the negative direction. The X direction handle. The Y direction handle. The Z direction handle. A non-optional argument was NULL 2013

Obtains the handles representing the cardinal directions in 2D.

True if the handles returned should be in the positive direction, false if the handles should be in the negative direction. The collection of handles. 2012

Obtains the handles representing the cardinal directions in 3D.

True if the handles returned should be in the positive direction, false if the handles should be in the negative direction. The collection of handles. 2012

Sets the handle representing the 2D origin.

The origin handle. A non-optional argument was NULL 2013

Sets the handle representing the 3D origin.

The origin handle. A non-optional argument was NULL 2013

Obtains the handle representing the 2D origin.

The handle. 2012

Obtains the handle representing the 3D origin.

The handle. 2012

Obtains the relative transform between two IfcLocalPlacement handles.

The original placement from which the result transforms coordinates and directions. The relative placement to which the result transforms coordinates and directions. The transform from the original placement to the new placement. A non-optional argument was NULL 2012

Identifies if the given curve element is generated by another element's sketch, or if it represents an independent curve element accessible directly by the user.

The curve element. True if the curve element was generated by a sketch, false if it is independent. A non-optional argument was NULL 2012

Gets the sub elements from a legacy curtain element.

The legacy curtain element. The element array. A non-optional argument was NULL 2013

Obtains a list of columns known to Revit as intersecting with this wall.

The wall. The columns found. A non-optional argument was NULL 2012

Obtains the IFC-specific information regarding the connections between this wall and other elements.

The wall. The location on the wall from where the connections should be obtained. This should be either IFCConnectedWallDataLocation.Start or IFCConnectedWallDataLocation.End. The connection information. A non-optional argument was NULL A value passed for an enumeration argument is not a member of that enumeration 2012

Returns one or more properties for legacy (created in R2012 or before) Stairs.

The exporter. the legacy stair. Number of Risers in the Stair. Number of Treads in the Stair. Riser Height of the risers in the Stair. Tread length of the treads in the Stair. Minimum Tread length of the treads in the Stair. Nosing length of the treads in the Stair. Waist thickness of the flight of stair. A non-optional argument was NULL 2013

Obtains the unscaled transform from an IfcLocalPlacement handle.

The exporter. The placement handle. The transform. A non-optional argument was NULL 2012

Obtains the spatial element boundary curves as an array of CurveLoops, needed for processing into IFC-specific elements later.

The spatial element. The options for extraction of the boundaries. If true, curves will be trimmed to meet their neighbors. If false, no trimming will take place. The list of CurveLoops. A non-optional argument was NULL Unable to get boundary curve loops for the spatial element. 2012

Exports the openings associated to an IfcSlab exported as an extrusion.

The ExporterIFC class. The base slab element. The base level information. The local placement of the slab. The list of IfcSlabs created from the initial element. The profile curves for the extrusions, including the opening curves. The plane of the profile curves. The product wrapper. A non-optional argument was NULL 2014

Attempts to export an IfcSlab using extrusions, clippings and openings by analyzing the geometry of the element. Used for more advanced cases than the ExtrusionAnalyzer.

The ExporterIFC class. The element to be exported. The model geometry of the element. The transform setter. The initial local placement based on the base level. The local placement, potentially modified by this function. The entity handles corresponding to the slab representations. The curve loops representing the profile of the extrusion. Extra calculated information for each of the profile loops. The plane of the profile curves. Returns true if successful, false otherwise. A non-optional argument was NULL 2012

Returns the projected area of the room, unscaled.

The roof. The projected area. A non-optional argument was NULL 2013

Obtains the IFC type associated to the given element for the current export.

IFC type names are affected by the user's entries in the mapping file set for a given export operation. The element. The exporter. The IFC type. This is an empty string if the element should not be exported because it is not found in the mapping file. A non-optional argument was NULL 2012

Obtains the IFC class name associated to the given element for the current export.

IFC class names are affected by the user's entries in the mapping file set for a given export operation. The element. The exporter. The IFC class name. This is an empty string if the element should not be exported because it is not found in the mapping file. A non-optional argument was NULL 2012

Obtains the IFC class name associated to a given category id for the current export.

IFC class names are affected by the user's entries in the mapping file set for a given export operation. The category id. The exporter. The IFC class name. This is an empty string if the element should not be exported because it is not found in the mapping file. A non-optional argument was NULL 2013

Gets the openings data from the element.

The exporter. The element. The local coordinate system for the extrusion. The range. This consists of two double values representing the height in Z at the start and the end of the range. If the values are identical the entire element is used. The opening data. A non-optional argument was NULL 2017

Processes the geometry of the wall to create an extruded area solid representing the geometry of the wall (including any clippings imposed by neighboring elements).

The exporter. The wall. The offset from the placement setter. The range. This consists of two double values representing the height in Z at the start and the end of the range. If the values are identical the entire wall is used. The overall span in Z of the wall. The IfcExtrudedAreaSolid handle generated initially for the wall. A collection of extruded openings that can be derived from the wall geometry. IfcEtxtrudedAreaSolid handle. This may be the same handle as was input, or a modified handle derived from the clipping geometry. If the function fails this handle will have no value. A non-optional argument was NULL 2012

Gets the curve loop(s) that represent the bottom or top face of the wall, usable to create an extrusion for the wall geometry.

This function is intended to help determine if a Revit Wall can be exported as an IfcWallStandardCase. The conditions for exporting an IfcWallStandardCase require that the geometry of the wall be described as one profile curve loop extruded in the Z direction, with potential clip planes and openings applied to the base geometry. This function will use either the top or bottom face to determine the boundary curve loop. Regardless of whether the top or bottom face is used, the curve loop will be located on the plane corresponding to the base of the wall. The exporter. The wall. The curve loops. If the function has failed, this collection will be empty. A non-optional argument was NULL 2012

Identifies if the wall's base can be represented by a direct thickening of the wall's base curve.

The wall. The wall's base curve. True if the wall's base can be represented by a direct thickening of the wall's base curve. False is the wall's base shape is affected by other geometry, and thus cannot be represented by a direct thickening of the wall's base cure. The input curve points to a helical curve and is not supported for this operation. A non-optional argument was NULL 2012

Identifies if the base geometry of the wall can be represented as an extrusion.

The wall or in-place wall element. The range. This consists of two double values representing the height in Z at the start and the end of the range. If the values are identical the entire wall is used. True if the wall export can be made in the form of an extrusion, false if the geometry cannot be assigned to an extrusion. A non-optional argument was NULL 2012

Obtains a special snapshot of the geometry of an in-place wall element suitable for export.

The in-place wall instance. The in-place wall geometry. Returns if there is no special geometry for the wall needed for export; the standard geometry of the wall can be used. A non-optional argument was NULL 2012

Obtains the curve loops which bound the wall's elevation profile.

The wall. The collection of curve loops. The wall does not have an elevation profile. A non-optional argument was NULL 2012

Identifies if the wall has a sketched elevation profile.

The wall. True if the wall has a sketch elevation profile, false otherwise. A non-optional argument was NULL 2012

Obtains the curve of the wall trimmed or extended according to the end conditions of the wall.

The wall. The trimmed or extended curve. A non-optional argument was NULL 2012

Obtains the base offset of the wall.

The wall. The base offset of the wall. A non-optional argument was NULL 2012

Determines if the input wall is completely removed by interaction with other elements within the given range.

The wall. The exporter. The range. This consists of two double values representing the height in Z at the start and the end of the range. If the values are identical the entire wall is used. True if the wall should be ignored within the given range. A non-optional argument was NULL 2012

Determines whether two solids are identical, potentially offset from each other.

The first solid. The second solid The offset transform True if they are identical, false otherwise. A non-optional argument was NULL 2013

Obtains the transform for the door or window instance.

The family instance. The family symbol. Is the door or window flipped in X? Is the door or window flipped in Y? The transform. A non-optional argument was NULL 2014

Obtains the minimum width of the given FamilySymbol.

The family symbol. The minimum width. A non-optional argument was NULL 2012

Obtains the minimum height of the given FamilySymbol.

The family symbol. The minimum height. A non-optional argument was NULL 2012

Identifies if the family instance has its own geometry, or uses the symbol's geometry with a transform.

A Family Instance can have its own copy of geometry, or use the symbol's geometry with a transform. This method identifies the source of this family instance's geometry. The family instance. True if the instance has its own geometry. False if the symbol's geometry is used. A non-optional argument was NULL 2012

Returns the original family symbol of this family instance, before the instance is modified by joins, cuts, coping, extensions, or other post-processing.

The FamilyInstance. The original FamilySymbol. A non-optional argument was NULL 2012

Collects all the target geometry from the input geometry object and adds it as IFC handles to the IFCInfo.

The type of geometry collected is determined by the method of creation for the IFCGeometryInfo. The exporter. The container object which collects the geometry. The geometry object to be processed. The offset to apply to each of the collected geometry handles. True to process geometry which is not set as visible. False to only process visible geometry. An overall transform to apply to each of the collected geometry handles. A non-optional argument was NULL 2012

Collects all the target geometry from the input geometry object and adds it as IFC handles to the IFCInfo.

Converts a vector from global Revit coordinates to current IFC coordinates, including scale.

The exporter. The original vector. The transformed and scaled point. A non-optional argument was NULL 2013

Converts a point from global Revit coordinates to current IFC coordinates, including scale.

The exporter. The original point. The transformed and scaled point. A non-optional argument was NULL 2013

Does validity checks on a list of curve loops to ensure that they are all co-planar, closed, and properly oriented.

The loops to check. The normal. returns the curve loops properly oriented, if possible. If not, the return contains no loops. A non-optional argument was NULL 2013

Checks if the region bounded by the input curve loop can be represented as the subtraction of 0 or more convex polygons from a base convex polygon.

This function is intended to be used to determine if the geometry of a wall with an elevation profile can be successfully represented as a vertical extrusion with one or more openings removed. If this function is to return true, the subtracting polygons must each have at least one edge coincident with the base convex polygon. Before the check is performed, this input curve will be trimmed by the range extents of the wall, if any. The input curve loop. It is intended that this curve loop have been obtained from the elevation profile of a wall. The wall from which the curve loop was obtained. The range extents of the wall. If the function returns false but this returns true, the loop could be obtained but was degenerate. Thus there is no extrusion that can be produced. True if the region can be represented by a boolean combination of polygons, false otherwise. A non-optional argument was NULL 2012

Sorts a set of curve loops such that outer and inner loops are separated.

Outer loops are separated and inner loops are grouped according to their outer loop. Loops are assumed to be non-intersecting, and there will be no nesting of inner loops (that is, an inner loop of an inner loop is another outer loop). The curve loops. The sorted collection of loops. A non-optional argument was NULL 2012

Gets the components of a stair or ramp.

The exporter. The legacy stair or ramp element. The LegacyStairOrRamp that contains the components. NULL means the components can't be determined. A non-optional argument was NULL 2013

Computes total area of the list of curve loops. If the area cannot be calculated, returns 0.0.

All curve loops in the list must be planar and lie in the same plane. Computed area. A non-optional argument was NULL 2012

Returns the number of non-empty, non-duplicate building stories in the file.

The exporter. The number of stories. A non-optional argument was NULL 2013

Checks if wall is joined to top.

The wall. True if wall is joined to top, false if not. A non-optional argument was NULL 2013

Use the internal Revit implementation to relate elements at the end of export.

The exporter. A non-optional argument was NULL 2013

Creates a consistent GUID for an IFC entity related to a Revit element. A "related" sub-element is one that is unique for a given type of element, and can therefore by identified by a simple index value (e.g. PSet_Wall_Common property set for a wall.) The index value 0 is reserved, as this would generate the GUID of the element itself. A listing of known sub-elements is contained in IFCSubElementEnums.cs; it is expected that this list would be maintained up-to-date, instead of passing arbitrary values into this function.

The element. The global index for this sub-element. The guid string. A non-optional argument was NULL 2013

Creates a GUID for the given element.

The element. The guid string. A non-optional argument was NULL 2013

Creates a GUID from Revit project for given GUIDType.

The document. The GUID type. The guid string. A non-optional argument was NULL A value passed for an enumeration argument is not a member of that enumeration 2013

Creates a randomized GUID.

The guid string. 2013

Gets the curve loop corresponding to the hole in the wall made by the instance.

The document. The host wall. The hosted instance. The direction of the hole relative to the location of the curve loop. The opening in the wall. A non-optional argument was NULL 2014

Gets the arcs associated with the plan view of a door.

The family. The arcs. A non-optional argument was NULL 2014

Splits a roof or floor element composed of planar surfaces into a set of roughly vertical extruded loops of uniform depth if possible.

The roof or floor. A collection of computed components. The host object roofOrFloor must be a floor or a non face-based roof. A non-optional argument was NULL The roof or floor cannot be split into subcomponents by this routine. Possible reasons are, among others: (1) the roof or floor contains non-planar surfaces, (2) the roof or floor cannot be divided into sub-components of equal thickness, or (3) the roof subcomponents contain inner boundary loops. 2016

Gets the components of roof slabs.

The exporter. The roof element. The roof components. A non-optional argument was NULL 2014

Gets the level if by the height of the element.

The exporter. The element. The level id. A non-optional argument was NULL 2014

A class that contains utilities needed to implement Revit's version of the IFC export client application.

This class contains special API utilities needed to enable the implementation of the client application for IFC export. Some of these utilities will be needed temporarily while the code for IFC export is migrated into the export client. These temporary interfaces are likely to change in upcoming Revit releases. 2012

Gets opening solids.

The solids. 2014

Gets extrusion data.

The extrusion data. 2014

Specifies whether the .NET object represents a valid Revit entity.

Trus if it is a recess, false if it is an opening.

2014

The opening element id.

2014

A class that contains opening data including extrusion data, opening solids and opening element id.

2014

The areas of CurveLoops of roof slabs.

2014

The faces of the loops of roof slabs.

The faces. 2014

The CurveLoops of roof slabs.

The CurveLoops. 2014

The plane origins of roof slabs.

The origins. 2014

The plane directions of roof slabs.

The directions. 2014

Specifies whether the .NET object represents a valid Revit entity.

The depth of the roof slab.

2014

A class that contains multiple roof slab infos of a roof.

This class contains a series of collections that are all of the same length, and whose nth index corresponds to the nth slab of the roof. 2014

Gets the CurveLoop representing the base profile curve loop of the roof or floor slab

The CurveLoop. 2016

Gets the plane representing the normal and origin of the surface containg the base profile curve loop of the roof or floor slab.

The plane. 2016

Specifies whether the .NET object represents a valid Revit entity.

The area of the CurveLoop of the roof or floor slab.

2016

The face of the loops of the roof or floor slab.

2016

The depth of the roof or floor slab.

The depth is the thickness of the slab as measured perpendicular to the slab's main faces, as opposed to the vertical extrusion distance. 2016

A class that contains roof or floor slab information, calculated by ExporterIFCUtils.ComputeSubcomponents().

A slab is an extrusion with one outer and no inner base profile curve loops, created by extruding the base profile loop in the direction Plane.Normal a distance given by the Depth value. 2016

Gets walk lines.

The walk lines. 2015

Gets boundary lines.

The boundary lines. 2015

Gets the length of treads.

The length of treads. 2013

Gets the number of treads.

The list of numbers of treads. 2013

Gets the number of risers.

The list of numbers of risers. 2013

Gets the geometries of stringers.

The geometries of stringers. 2013

Gets the geometries of landings.

The geometries of landings. 2013

Gets the geometries of runs.

The geometries of runs. 2013

Specifies whether the .NET object represents a valid Revit entity.

True if it is a ramp, false if it is a stair.

2013

The height of riser.

2013

The class contains the components of a legacy stair or ramp.

2013

Gets the extruded solid handle generated for the family instance.

The handle. If the extrusion analysis failed for the family, this will be a handle with no value assigned. 2012

Gets the set of "openings" determined from the analysis of the instance geometry.

The extra openings. 2012

Specifies whether the .NET object represents a valid Revit entity.

The extra offset determined from the geometry of the family instance.

2012

The best material id determined for the family instance.

2012

This class represents the results of a geometric analysis of a family instance.

The analysis attempts to convert the geometry of the instance into a single extrusion with additional extruded openings cutting the main solid. 2012

Adds a site (IfcObject) handle to associate with the IfcProduct in this wrapper.

The site handle. A non-optional argument was NULL 2013

Clear finish materials in this wrapper.

2013

Adds a material handle to associate with the IfcProduct in this wrapper.

The material handle. A non-optional argument was NULL 2013

Adds an annotation handle to associate with the IfcProduct in this wrapper.

If the IFCLevelInfo is not provided, and relateToLevel to true, the handle will be associated to the building handle. The annotation handle. Information on the associated level. Optional, can be . True to relate the annotation to the level, false otherwise. A non-optional argument was NULL 2012

Adds an IfcElement handle to associate with the IfcProduct in this wrapper.

If the IFCLevelInfo is not provided, and relateToLevel to true, the handle will be associated to the building handle. The IfcElement handle. The level info. The extrusion creation data associated with the given element. Optional, can be . True to relate the element to the level, false otherwise. A non-optional argument was NULL 2013

Adds an IfcBuilding handle to associate with the IfcProduct in this wrapper.

The IfcBuilding handle. A non-optional argument was NULL 2012

Adds an IfcSpace handle to associate with the IfcProduct in this wrapper.

If the IFCLevelInfo is not provided, and relateToLevel to true, the handle will be associated to the building handle. The IfcSpace handle. Information on the associated level. The extrusion creation data associated with the given space. Optional, can be . True to relate the space to the level, false otherwise. A non-optional argument was NULL 2012

Obtains the extrusion creation data associated with the given element.

The handle. The parameters. if no parameters are associated with the element. A non-optional argument was NULL 2012

Gets the first element handle added to this wrapper.

The handle. 2013

Gets all objects associated with the IfcProduct in this wrapper.

The collection of objects. 2012

Establishes a new product manager for elements and objects derived from a parent product manager, allowing override of allowRelateToLevel

The parent product manager. True to allow associated elements and objects to relate to a level, false to never allow such a relationship. The new product manager. A non-optional argument was NULL 2013

Establishes a new product manager for elements and objects derived from a parent product manager.

The parent product manager. The new product manager. A non-optional argument was NULL 2012

Establishes a new baseline product manager for elements and objects.

Elements and objects associated to this product manager will be associated to a top-level IfcProduct based on the world coordinate system of the output file. The exporter. True to allow associated elements and objects to relate to a level, false to never allow such a relationship. The new baseline product manager. A non-optional argument was NULL 2012

Specifies whether the .NET object represents a valid Revit entity.

The number of objects associated with the IfcProduct in this wrapper.

2012

This class is used to ensure that elements and objects are associated with the current IfcProduct.

Each instance makes sure that any elements and products created during its lifetime are properly associated to their parent level (or other containing object). To ensure that the lifetime of the object is correctly managed, you should declare an instance of this class as a part of a 'using' statement in C# or similar construct in other lanuguages. 2012

Initializes the transformation in the transform setter.

The exporter. The transform. A non-optional argument was NULL 2012

Initializes the transformation in the transform setter.

The exporter. The set of geometry used to determine the bounding box. The extrusion creation data which contains the local placement. The transform corresponding to the movement, if any. A non-optional argument was NULL 2012

Creates a new instance of a transform setter.

The new transform setter. 2012

Specifies whether the .NET object represents a valid Revit entity.

A state-based class that forces an extra transformation applied to objects being exported.

IFC has a system of local placements; these are created from a set of transforms in Revit. Sometimes there is a need to create a 'fake' transform to get the right local placement structure for IFC. This class is intended to maintain the transformation for the duration that it is needed. To ensure that the lifetime of the object is correctly managed, you should declare an instance of this class as a part of a 'using' statement in C# or similar construct in other lanuguages. 2012

Specifies whether the .NET object represents a valid Revit entity.

The ending value of the range.

2013

The starting value of the range.

2013

Instantiates an IFCRange object by copy.

The IFCRange object. A non-optional argument was NULL 2013

Instantiates an IFCRange object.

The starting value of the range. The ending value of the range. 2013

Instantiates a default IFCRange object.

The starting and ending value are both set to zero. 2013

Typically for IFC export, this represents the lower and upper elevations for split wall and column geometry.

It contains two double values representing the starting and ending values as a range. 2013

The method that Revit will invoke to perform an export to IFC.

There will be a transaction group opened for the document. Any changes made to the document must be temporary, as the transaction group will automatically be rolled back at the end. The document to export. The IFC exporter object. The view whose filter visibility settings govern the export. 2012

The method that Revit will invoke to perform an export to IFC.

The interface used to implement a custom IFC exporter.

Implement this interface and register an instance of the derived class with ExporterIFCRegistry. 2012

Get (or create) the IfcFillPatternStyle associated with an ElementId.

The fill pattern id. The pattern color. The view scale. The IfcSurfaceStyle. A non-optional argument was NULL 2013

Gets all elements not associated to stories.

The collection of elements. 2013

Gets all products not associated to stories.

The collection of products. 2013

Removes an IFCLevelInfo corresponding to a level from the exporter's internal cache.

The level id. A non-optional argument was NULL 2013

Adds building storey to the exporter's internal cache.

The level id. The IFCLevelInfo object. A non-optional argument was NULL 2013

This sets the material id that is to be associated with the element in the current export state.

Even though there could be several materials associated with the element (set during PushExportState()), unless the element has support for IfcMaterialLayerSet, IFC output will include only this one. The material id. A non-optional argument was NULL 2012

This gets the material id that is associated with the element in the current export state.

Gets the name of the element assigned to the current export state.

The family name is prepared for use in IFC output during the call to PushExportState(). The family name. 2013

Resets the internal state of the exporter to process the previously active input element (if any), or the default state if the stack is empty.

2012

Sets the internal state of the exporter to process the geometry and properties of the input element.

The element will be assigned until PopExportState() is called. The element. The geometry of the element. Optional, can be . A non-optional argument was NULL 2012

Sets an IfcShapeRepresentation to be used for the IfcPresentationLayerAssignment associated with the given Revit category and element.

The element. The category id. The IfcShapeRepresentation handle. A non-optional argument was NULL 2012

Get the handle to the opening associated with a hosted (door/window) element from the internal cache.

The id of the door or window. The opening handle. A non-optional argument was NULL 2014

Registers a door or window in the ExporterIFC's internal cache. The ids registered correspond to openings in walls which have not been processed and created yet.

The id of the door or window. The handle to the IfcDoor or IfcWindow created for this instance. A non-optional argument was NULL 2012

Sets the IfcRepresentationContext or IfcRepresentationSubContext handle to be used for 3D entities (Model entities).

The IfcRepresentationContext for 3D entities. The name of the IfcRepresentationSubContext, or the IfcRepresentationContext if the string is empty, for 3D entities. A non-optional argument was NULL 2013

Obtains the IfcRepresentationContext or IfcRepresentationSubContext handle to be used for 3D entities (Model entities).

The context handle automatically incorporates the angle to true north for the document. The name of the IfcRepresentationSubContext, or the IfcRepresentationContext if the string is empty, for 3D entities. The IfcRepresentationContext for 3D entities. A non-optional argument was NULL 2012

Sets the IfcRepresentationContext handle to be used for 2D entities (Annotations).

The IfcRepresentationContext. A non-optional argument was NULL 2013

Obtains the IfcRepresentationContext handle to be used for 2D entities (Annotations).

The context handle is automatically applied with a 1:100 scale. The IfcRepresentationContext. 2012

Clear face with element handle map.

2014

The face. The element handle. A non-optional argument was NULL 2014

Returns a collection containing the information about all levels in the document.

Level information is currently automatically collected and cached in the ExporterIFC object. This method returns the cached information which is often needed during export of particular building elements which reference levels, as well as to implement automatic wall and column splitting. The collection of level information. 2012

Returns an object representing the information about a level in the document.

Level information is currently automatically collected and cached in the ExporterIFC object. This method returns the cached information for a given level, which is often needed during export of particular building elements which reference levels, as well as to implement automatic wall and column splitting. The level id. The level information. A non-optional argument was NULL 2012

Returns a collection containing the host object handles in the document.

Host object handles is currently collected by RegisterSpaceBoundingElementHandle and exporting internal element and cached in the ExporterIFC object. This method returns the cached information which is needed to create wall connectivity objects. The collection of host objects. 2013

Looks up the handle associated to the element and level id from the ExporterIFC's internal cache.

The Revit element id to look for. The element level id. The handle associated to the element and level id. If the id is not found in the cache, an empty handle is returned (HasValue == false). A non-optional argument was NULL 2013

Stores a handle representing a space bounding element to the ExporterIFC's internal cache.

The cache of space bounding elements will be used during completion of export to create relationship objects such as IfcRelSpaceBoundary and IfcRelConnectsPathElements. The types of Revit elements accepted by this function are: WallsCurtain wallsRoofsFloorsDoorsWindows The handle to the space bounding element. The Revit element id associated to this handle. The level id assigned to the space bounding object. A non-optional argument was NULL 2012

Gets the collection of named options set by the exporter client.

The collection of named options. 2013

Sets the handle to the IfcOwnerHistory for the file.

The handle. A non-optional argument was NULL 2013

Sets the handle to the IFC file being created during this export operation.

The handle to the file. A non-optional argument was NULL 2012

Resets the internal transform of the exporter to process the previously active input element (if any), or the default transform if the stack is empty.

2014

Sets the internal transform of the exporter to process the geometry and properties of the input element.

The transform. A non-optional argument was NULL 2014

Gets the handle to the IFC file being created during this export operation.

The handle to the file. 2012

Specifies whether the .NET object represents a valid Revit entity.

Identifies if division of multi-level walls and columns by levels should take place during this export.

2012

Identifies the level of space boundaries being exported.

There are three valid values for this integer: 0 = export no space boundaries. This can save space if the receiving application doesn't use them. 1 = export 1st level space boundaries. This is the default. 2 = export 2nd level space boundaries. This is primarily for use in energy analysis programs, and the GSA. 2012

Identifies if the export should include IFC standard quantities currently supported by Revit.

2012

Identifies the file version being exported.

2012

Identifies if the file version being exported is 2x3.

Returns true even for alternative formats equivalent to 2x3, such as COBIE. 2012

Identifies if the file version being exported is 2x2.

Returns true even for alternative formats equivalent to 2x2, such as BCA. 2012

The name of the IFC file being exported.

2012

The main class provided by Revit to allow implementation of IFC export.

An instance of this class is provided to clients which implement IExporterIFC in order to provide an implementation for IFC export. It contains information on the options selected by the user for the export operation, as well as members used to access specific types of data needed to implement the export properly. 2012

Specifies whether the .NET object represents a valid Revit entity.

The location for the join.

2012

The element id to which this element is joined.

2012

A class that contains the IFC-specific information about how an element is joined to another element.

2012

Gets the local placement.

The local placement. 2014

Gets all building elements on this level.

The collection of elements. 2013

Gets all building products on this level.

The collection of products. 2013

Gets the IfcBuildingStorey handle.

The handle. 2012

Creates an IFCLevelInfo.

The building storey handle (IfcBuildingStorey). The local placement handle (IfcLocalPlacement). The height of the level. The elevation of the level. The scale factor. True if this is primary level, false otherwise. The IFCLevelInfo object. A non-optional argument was NULL 2013

Specifies whether the .NET object represents a valid Revit entity.

The elevation of the level.

2012

The distance to the next story level.

2012

Represents information about a particular level in the document.

Level information includes the height, which is the distance to from this level to the next available level, and the actual elevation of the level, in the Revit default units. 2012

Removes all cached openings from the data.

2012

Adds an opening to the data.

The opening is stored for retrieval later via GetOpenings(). The opening. A non-optional argument was NULL 2012

Gets a collection of all of the openings stored in this data.

Contains all of the openings stored via AddOpening(). The opening information. 2012

Gets the reference to the IfcLocalPlacement handle used when creating the extrusion.

The IfcLocalPlacement handle. 2012

Sets the data to reference an IfcLocalPlacement handle when creating the extrusion. Side effect: will set ReuseLocalPlacement to true.

The IfcLocalPlacement handle. A non-optional argument was NULL 2012

Specifies whether the .NET object represents a valid Revit entity.

True if inner regions of the extrusion should become openings, false otherwise.

2012

The extrusion direction to generate an extrusion.

When setting this property: A non-optional argument was NULL 2012

The custom extrusion axis to try when generating an extrusion.

When setting this property: A non-optional argument was NULL 2012

Identifies if the data contains a extrusion direction.

2012

Identifies if the data contains a custom extrusion axis.

2012

The axes to try when generating the properties of the extrusion.

When setting this property: A value passed for an enumeration argument is not a member of that enumeration 2012

Allows re-use of local placement when creating a new local placement due to shifting of breps when moving towards the origin.

2013

Allows vertical shifting of breps when moving towards the origin.

2013

The outer perimeter of the extrusion, scaled to the units of export.

This value represents the perimeter of the outermost curve loop bounding the area of the extrusion. Zero if the perimeter has never been set on this object. 2012

The inner perimeter of the extrusion, scaled to the units of export.

This value represents the perimeter of all of the inner curve loops within the area of the extrusion. Zero if the perimeter has never been set on this object. 2012

The width of the extrusion, scaled to the units of export.

Zero if the width has never been set on this object. 2012

The slope of the extrusion, in degrees.

Zero if the slope has never been set on this object. 2012

The length of the extrusion, scaled to the units of export.

Zero if the length has never been set on this object. 2012

The height of the extrusion, scaled to the units of export.

Zero if the height has never been set on this object. 2012

The area of the extrusion, scaled to the units of export.

The value will be 0.0 if the area has never been set on this object. 2012

True to create new local placement with identity transform.

2014

The default constructor.

All input data will be considered uninitialized. 2012

A utility object that is used to pass information related to extrusion creation.

This class accepts input used to attempt to create an extrusion (possibly with openings) from Revit geometry. The output contains information about the created extrusion and its openings. The information set is used to generate properties for the extruded body and related opening elements in the IFC file. 2012

Calculates the extrusion data from a collection of Revit geometry faces.

The options for extrusion extraction. The collection of faces. A collection of extrusion data calculated for the geometry. If the function fails to calculate one or more valid extrusions, this collection will be empty. A non-optional argument was NULL 2012

Calculates the extrusion data from a Revit geometry object.

The options for extrusion extraction. The geometry object. A collection of extrusion data calculated for the geometry. If the function fails to calculate one or more valid extrusions, this collection will be empty. A non-optional argument was NULL 2012

A utility class used to calculate extrusion data from Revit geometry for IFC export.

2012

Specifies whether the .NET object represents a valid Revit entity.

The scaling factor for length measurements from the default Revit units to the export units.

2012

The custom axis to try (if extrusionAxes includes an option for a custom direction).

When setting this property: A non-optional argument was NULL 2012

The extrusion axes to try when doing the calculation.

When setting this property: A value passed for an enumeration argument is not a member of that enumeration 2012

Constructs a new instance of a class used to calculate extrusions from Revit geometry.

The exporter. The extrusion axes to try when doing the calculation. The custom axis to try (if extrusionAxes includes an option for a custom direction). The scaling factor for length measurements from the default Revit units to the export units. A non-optional argument was NULL A value passed for an enumeration argument is not a member of that enumeration 2012

This class contains the options used to calculate extrusions from Revit geometry.

2012

Gets the curve loops that form the base shape of the extrusion.

The collection of loops. 2012

Clears the curve loops stored in the extrusion data.

2012

Removes the loop at the specified index.

The zero-based index of the loop to remove. 2012

Adds a curve loop to the extrusion data.

The curve loop. A non-optional argument was NULL 2012

Determines if the extrusion data represents a valid extrusion.

True if the extrusion is valid, false otherwise. 2012

Specifies whether the .NET object represents a valid Revit entity.

The direction used for the extrusion.

When setting this property: A non-optional argument was NULL 2012

The basis used for the extrusion.

When setting this property: A value passed for an enumeration argument is not a member of that enumeration 2012

The length of the extrusion, scaled in the units of the export.

2012

Constructs a new empty extrusion data object.

2012

Represents the geometry of an extrusion (a solid body or opening) generated from Revit geometry.

2012

This enumerated type represents the possible bases for derivation of extrusion geometry.

2012

The Z direction.

The Y direction.

The X direction.

An invalid basis (typically indicating that the extrusion extraction was unsuccessful).

Represents the possible axes to try when generating an extrusion using IFCCreateExtrusionData.

2012

The x-, y-, and z-axes, and a custom direction.

A custom direction.

The x-, y-, and z-axes.

The y- and z-axes.

The x- and z-axes.

The z-axis.

The x- and y-axes.

The y-axis.

The x-axis.

The default value.

Rolls back all changes made to the IFC file during the transaction.

2012

Commits all changes made to the IFC file during the transaction.

2012

Specifies whether the .NET object represents a valid Revit entity.

Instantiates a transaction object.

The transaction starts by creating a transaction object. The IFC file for which this transaction is going to be used. A non-optional argument was NULL 2012

IFC transactions are context-like objects that guard any changes made to an IFC file.

Any change to an IFC file can only be made while there is an active transaction open for that file. Changes do not become a part of the file until the active transaction is committed. Consequently, all changes made in a transaction can be rolled back either explicitly or implicitly (by the destructor). 2012

Creates and populates an IfcStyledItem for an IfcRepresentationItem with a IfcSurfaceStyle, IfcCurveStyle, and/or an IfcFillStyle, and assigns them to the file.

The exporter. The representation item. The color. The fill pattern id. The handle. A non-optional argument was NULL A transaction is required for this operation. 2013

Creates and populates an IfcStyledItem for an IfcRepresentationItem with a IfcSurfaceStyle, IfcCurveStyle, and/or an IfcFillStyle, and assigns them to the file.

The exporter. The representation item. The handle. A non-optional argument was NULL A transaction is required for this operation. 2012

Counts IFC instances of one particular type.

The name of the instance type. True to count instances of sub types. The count. A non-optional argument was NULL 2014

Gets IFC instances of one particular type.

The name of the instance type. True to retrieve instances of sub types. The instance handles. A non-optional argument was NULL 2014

Creates an IFC header instance in the file model.

file_schema, file_description and file_name must be created to get IFC file written successfully. Otherwise, the output IFC file would be empty. The instance name. The instance handle. A non-optional argument was NULL 2013

Creates an IFC instance in the file model.

The instance name. The instance handle. A non-optional argument was NULL 2013

Close the IFC file.

2013

Reads content from a file of IFC format.

The IFC file read options. The number of errors reported during the read process. The actual messages will be in the log file. The number of warnings reported during the read process. The actual messages will be in the log file. A non-optional argument was NULL Error reading opening model for unzipping. Error reading IFC file. 2015

Reads content from a file of IFC format.

The IFC file read options. A non-optional argument was NULL 2014

Writes content to a file of IFC format.

The IFC file write options. A non-optional argument was NULL 2013

Creates an IFC file for exporting.

The options. The IFC file. A non-optional argument was NULL 2013

Specifies whether the .NET object represents a valid Revit entity.

Represents the IFC file which is being created during export.

2012

Specifies whether the .NET object represents a valid Revit entity.

The XML configuration file name. It is used only for reading IFC-XML format file.

It uses default configuration if it is not set. When setting this property: A non-optional argument was NULL 2014

The full file name of the IFC file to be read.

When setting this property: A non-optional argument was NULL 2014

Creates a default IFCFileReadOptions.

2014

This class contains options to read an IFC file.

2014

Specifies whether the .NET object represents a valid Revit entity.

The XML configuration file name. It is used only for writing IFC-XML format file.

It uses default configuration if it is not set. When setting this property: A non-optional argument was NULL 2013

The file format of the IFC file.

When setting this property: A value passed for an enumeration argument is not a member of that enumeration 2013

The full file name of the IFC file to be written.

When setting this property: A non-optional argument was NULL 2013

Creates a default IFCFileWriteOptions. The default file format is ifc.

2013

This class contains options to write an IFC file.

2013

Specifies whether the .NET object represents a valid Revit entity.

Indicates if the inverses are controlled by Revit or users. True by users, false by Revit.

2013

The cache size of the file.

2013

The name of the schema.

When setting this property: A non-optional argument was NULL 2013

The full name of an IFC schema file.

When setting this property: A non-optional argument was NULL 2013

Creates a default IFCFileModelOptions. The default schema file is empty and cache size is 8192.

2013

This class contains options to create an IFC file model.

2013

The IFC file format.

2013

IFC-XML file, zipped to IFC-ZIP format.

IFC file, zipped to IFC-ZIP format.

IFC-XML format.

IFC format.

Determines whether the instance is an instance of the specified instance type or a subtype of this instance type.

The instance type name. True if the instance is an instance of the specified instance type or its subtype, false otherwise. A non-optional argument was NULL 2013

Determines whether the instance is an instance of exactly the specified instance type.

The instance type name. True if the instance is an instance of the specified instance type, false otherwise. A non-optional argument was NULL 2013

Unsets the attribute value.

The attribute name. A non-optional argument was NULL 2013

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The values. A non-optional argument was NULL 2015

Sets the attribute value.

The attribute name. The value. A non-optional argument was NULL 2013

Sets the attribute value.

The attribute name. The value. A non-optional argument was NULL 2013

Sets the attribute value.

The attribute name. The value. A non-optional argument was NULL 2013

Sets the attribute value.

The attribute name. The value. A non-optional argument was NULL 2013

Sets the attribute value.

The attribute name. The value. A non-optional argument was NULL 2013

Sets the attribute value.

The attribute name. The value. A non-optional argument was NULL 2013

Gets the attribute by name.

The name. The value. A non-optional argument was NULL 2013

Creates an attribute that is an aggregate.

The attribute name. The aggregate. A non-optional argument was NULL 2013

Clears the handle.

2013

Deletes the handle.

2012

Specifies whether the .NET object represents a valid Revit entity.

Identifies if the handle is empty or contains a value.

2012

The step id of the handle. Valid only for import.

2014

The name of the type of the handle.

2012

The integer identifier for the handle.

2012

Gets the integer value of the id as hash code

Determines whether the specified is equal to the current .

Another object.

Determines whether two IFCAnyHandles are different.

The first IFCAnyHandle. The second IFCAnyHandle. True if the IFCAnyHandles are different; otherwise, false.

Determines whether two IFCAnyHandles are the same.

The first IFCAnyHandle. The second IFCAnyHandle. True if the IFCAnyHandles are the same; otherwise, false.

A handle representing an item in an IFC file.

Handles are used to populate each line item in an IFC file. Each handle is assigned a unique identifier (an integer) which can be seen in the file contents at the start of the line. 2012

Returns an enumerator that iterates through a collection.

An IEnumerator object that can be used to iterate through the collection.

Returns an enumerator that iterates through a collection.

An IEnumerator object that can be used to iterate through the collection.

Gets the data value in the specified aggregate element.

The index. The data value. 2013

Returns a IFCAggregateIterator that iterates through the collection.

2013

Delete the aggregate object from the IFCFile model.

2013

Creates a nested aggregate and adds it to the aggregate.

The nested aggregate. The aggregate is not valid. 2013

Adds an element to the aggregate.

The IFCData element. A non-optional argument was NULL The aggregate is not valid. 2013

Specifies whether the .NET object represents a valid Revit entity.

The number of the data values in the aggregate.

2013

Get the IFCData for this aggregate.

The index. The IFCData.

A collection of IFC handles or attributes.

2013 Gets the item at the current position of the iterator.(Inherited from IEnumerator. Give it another property name to avoid confusing. And make it internal.)

Gets the item at the current position of the iterator.

There is no current item if the iterator has not started yet or has been done. There is no current item in the iterator.

Returns the current IFCData.

The current IFCData. 2013

Resets the iterator to the beginning of the aggregate.

2013

Increments the iterator to the next object in the IFCAggregate.

True if there is another available object in this iterator. False if the iterator has completed all available objects. 2013

Specifies whether the .NET object represents a valid Revit entity.

A class used to iterate individual objects in an IFCAggregate.

2013

The type of the GUID to be retrieved from Revit.

2013

The site GUID.

The building GUID.

The project GUID.

An enumerated type that represents the location where an element is connected to a wall.

2012

The connection type is not defined for this connection.

The conection is at some point along the path of the location line.

The connection is at the end of the wall location line.

The connection is at the start of the wall location line.

Gets storage value as IFCAggregate when its PrimitiveType is aggregate.

The IFCAggregate. The primitive type is not aggregate. 2013

Gets storage value as IFCAnyHandle when its PrimitiveType is instance.

The IFCAnyHandle. The primitive type is not instance. 2013

Gets storage value as string when its PrimitiveType is string, binary or enumeration.

The string value. The primitive type is not string, binary or enumeration. 2013

Gets storage value as IFCLogical when its PrimitiveType is logical.

The IFCLogical value. The primitive type is not logical. 2013

Gets storage value as boolean when its PrimitiveType is boolean.

The bool value. The primitive type is not boolean. 2013

Gets storage value as double when its PrimitiveType is double.

The double value. The primitive type is not double. 2013

Gets storage value as integer when its PrimitiveType is integer.

The int value. The primitive type is not integer. 2013

Gets the multiple strings represent one IFC type name.

The strings. No type assigned or it is a simple type. 2013

Sets the corresponding IFC type by its type list name.

This sets the IFC type represented by a string list. For example, DIMENSION(DIAMETER(INCH(5.0))). It's primitive type is double and the value is 5.0. Its IFC type is DIMENSION/DIAMETER/INCH. The string list represents the type is "DIMENSION"-"DIAMETER"-"INCH". The strings represent the name. A non-optional argument was NULL 2013

Gets the IFC type name.

The name. No type assigned or it is not a simple type. 2013

Determines if there is one corresponding IFC type.

False if there are no corresponding IFC types, or more than one; returns true otherwise. 2015

Sets the corresponding IFC type by its name.

The name of the type. A non-optional argument was NULL 2013

Creates a string data object of the specified type.

The string value. The type name. The IFCData object. A non-optional argument was NULL 2013

Creates a logical data object of the specified type.

The IFCLogical value. The type name. The IFCData object. A non-optional argument was NULL A value passed for an enumeration argument is not a member of that enumeration 2014

Creates a boolean data object of the specified type.

The boolean value. The type name. The IFCData object. A non-optional argument was NULL 2013

Creates a double data object of the specified type.

The double value. The type name. The IFCData object. A non-optional argument was NULL 2013

Creates an integer data object of the specified type.

The integer value. The type name. The IFCData object. A non-optional argument was NULL 2013

Creates an IFCAggregate data object.

The IFCAggregate value. The IFCData object. A non-optional argument was NULL 2013

Creates an IFCAnyHandle data object.

The IFCAnyHandle value. The IFCData object. A non-optional argument was NULL 2013

Creates a enum data object.

The string value. The IFCData object. A non-optional argument was NULL 2013

Creates a binary data object.

The string value. The IFCData object. A non-optional argument was NULL 2013

Creates a string data object.

The string value. The IFCData object. A non-optional argument was NULL 2013

Creates a logical data object.

The IFCLogical value. The IFCData object. A value passed for an enumeration argument is not a member of that enumeration 2013

Creates a boolean data object.

The boolean value. The IFCData object. 2013

Creates a double data object.

The double value. The IFCData object. 2013

Creates an integer data object.

The integer value. The IFCData object. 2013

Specifies whether the .NET object represents a valid Revit entity.

The primitive data type.

When setting this property: A value passed for an enumeration argument is not a member of that enumeration 2013

Identifies if the data is empty or contains a value.

2013

Gets the hash code.

Determines whether the specified is equal to the current .

Another object.

Determines whether two IFCDatas are different.

The first IFCData. The second IFCData. True if the IFCDatas are different; otherwise, false.

Determines whether two IFCDatas are the same.

The first IFCData. The second IFCData. True if the IFCDatas are the same; otherwise, false.

Creates a copy object.

The IFCData object. A non-optional argument was NULL 2013

A specialized type of abstract data block that can represent any data type.

2013

Used in operations to specify the primitive type of an IFCData.

2013

Unknown.

Represents IFCAggregate.

Represents IFCAnyHandle.

Enumeration. When reading or writing an IFCData of primitive type Enumeration, the value will be the string representation of the enumeration value as seen in the IFC specification.

Binary. When reading or writing an IFCData of primitive type Binary, the value will be the string representation of the binary value as seen in the IFC specification.

String.

IFCLogical type.

Boolean.

Double.

Integer.

A datatype can have values TRUE, FALSE or UNKNOWN.

2013

Unknown.

False.

True.

A path to a Revit model stored on a Revit server.

A path to a Revit model stored on disk.

Sets the handle to the IFC file being created during this import operation.

The handle to the file. A non-optional argument was NULL 2014

The entry point to the native IFC import function. Processes the main IfcProject and creates appropriate Revit elements.

This function allows for a "hybrid" .NET/native import. For any handle below, there will be no native processing, and it will be assumed that the element created in .NET is valid and appropriate. Note that this is only applicable for IFCAnyHandles that are subtypes of IfcProduct and IfcBuildingElementStorey; other handles will be ignored. Also, note that some elements have interdependencies that are not yet handled by this function. These include: 1. IfcDoor/IfcWindow and their IfcOpeningElements and 2D representations should both be created in the same environment (.NET or native). 2. Symbols and their instances should both be created in the same environment (.NET or native). The IfcProject containing the entities in the IFC file. The element ids for the already created elements. These handles will not be processed in native code. A non-optional argument was NULL 2015

The entry point to the native IFC import function. Processes the main IfcProject and creates appropriate Revit elements.

The IfcProject containing the entities in the IFC file. A non-optional argument was NULL 2014

Gets the collection of named options set by the importer client.

The collection of named options. 2015

Specifies whether the .NET object represents a valid Revit entity.

Gets the document associated with the import.

2015

The full file name of the IFC file to be import.

2014

The main class provided by Revit to allow implementation of IFC import.

An instance of this class is provided to clients which implement IImporterIFC in order to provide an implementation for IFC import. It contains information on the options selected by the user for the import operation, as well as members used to access specific types of data needed to implement the import properly. 2014

The method that Revit will invoke to perform an import from IFC.

The IFC importer. 2014

The method that Revit will invoke to perform an import from IFC.

The IFC importer. 2014

Interface for external servers implementing IFC import.

2014 Determines whether vectors are parallel within DOUBLE_EPS Returns: if parallel => 1 if not or if either is {0,0,0}. => 0 if antiparallel => -1 Determines whether vectors are parallel within ANGLE_EPS Returns: if parallel => 1 if not or if either is {0,0,0}. => 0 if antiparallel => -1 Returns true when the two vectors are almost equal. NOTE that the applied tolerance scales with the length of the vectors. USE WITH CAUTION. The triple product of of three vectors vec0, vec1, vec2 is defined as dot(cross(vec0, vec1), vec2). It is equal to the signed volume of the parallelepiped spanned by the three vectors. It is zero if and only if the vectors are linearly dependent. This function is equivalent to the Vec3d function vecVolume. Treats lhs and rhs as vectors and returns their cross product. Treats lhs and rhs as vectors and returns their dot product. returns a parallel unit vector or zero vector make this a unit vector or return ERR_NULL_VECTOR construct XYZ from components construct XYZ from Vec3d returns a unit vector in the Z-direction (0, 0, 1) returns a unit vector in the Y-direction (0, 1, 0) returns a unit vector in the X-direction (1, 0, 0) returns (0, 0, 0) literal constructors. expect heavy optimization. A self-initializing 3d point/vector class. Notes: This is intended to be a drop-in replacement for Vec3d. This means transparent operations with Vec3d, AKA double*, methods. This means the compiler may not catch some type errors. XYZ can be returned by value because the worst that can happen is gratuitous copying of 24 bytes, and we can live with it. In general, we let the compiler figure out the temporary storage and optimize inline functions.

A pointer to an ID2D1BitmapRenderTarget object.

Retrieves the bitmap for this render target. The returned bitmap can be used for drawing operations.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. When this method returns, contains the valid bitmap for this render target. This bitmap can be used for drawing operations.

Returns ID2D1BitmapRenderTarget interface

Pointer to an ID2D1BitmapRenderTarget interface or NULL if object is not initialized yet.

Returns ID2D1BitmapRenderTarget interface

Pointer to an ID2D1BitmapRenderTarget interface or NULL if object is not initialized yet.

Detaches render target interface from the object

Pointer to detached render target interface.

Attaches existing render target interface to the object

Existing render target interface. Cannot be NULL

Constructs a CBitmapRenderTarget object.

A pointer to an ID2D1DCRenderTarget object.

Returns ID2D1DCRenderTarget interface

Pointer to an ID2D1DCRenderTarget interface or NULL if object is not initialized yet.

Returns ID2D1DCRenderTarget interface

Pointer to an ID2D1DCRenderTarget interface or NULL if object is not initialized yet.

Binds the render target to the device context to which it issues drawing commands

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The device context to which the render target issues drawing commands The dimensions of the handle to a device context (HDC) to which the render target is bound

Creates a CDCRenderTarget.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The rendering mode, pixel format, remoting options, DPI information, and the minimum DirectX support required for hardware rendering.

Detaches render target interface from the object

Pointer to detached render target interface.

Attaches existing render target interface to the object

Existing render target interface. Cannot be NULL

Constructs a CDCRenderTarget object.

ID2D1DCRenderTarget wrapper.

A pointer to an ID2D1HwndRenderTarget object.

Changes the size of the render target to the specified pixel size

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The new size of the render target in device pixels

Indicates whether the HWND associated with this render target is occluded.

A value that indicates whether the HWND associated with this render target is occluded.

Returns the HWND associated with this render target.

The HWND associated with this render target.

Returns ID2D1HwndRenderTarget interface.

Pointer to an ID2D1HwndRenderTarget interface or NULL if object is not initialized yet.

Returns ID2D1HwndRenderTarget interface.

Pointer to an ID2D1HwndRenderTarget interface or NULL if object is not initialized yet.

Re-creates a render target associated with the window

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The HWND associated with this render target

Creates a render target associated with the window

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE The HWND associated with this render target

Detaches render target interface from the object

Pointer to detached render target interface.

Attaches existing render target interface to the object

Existing render target interface. Cannot be NULL

Constructs a CHwndRenderTarget object from HWND.

The HWND associated with this render target

ID2D1HwndRenderTarget wrapper.

A pointer to CD2DTextFormat object that contains a default text format.

A list of pointers to CD2DResource objects.

A pointer to an ID2D1RenderTarget object.

Verifies CD2DResource object validity; creates the object if it didn't already exist.

Pointer to CD2DResource object. TRUE is object if valid; otherwise FALSE.

Removes the last axis-aligned clip from the render target. After this method is called, the clip is no longer applied to subsequent drawing operations.

The size and position of the clipping area, in device-independent pixels. The antialiasing mode that is used to draw the edges of clip rects that have subpixel boundaries, and to blend the clip with the scene contents. The blending is performed once when the PopAxisAlignedClip method is called, and does not apply to each primitive within the layer.

Sets the render target's drawing state to that of the specified ID2D1DrawingStateBlock.

The new drawing state of the render target.

Saves the current drawing state to the specified ID2D1DrawingStateBlock.

When this method returns, contains the current drawing state of the render target. This parameter must be initialized before passing it to the method.

Executes all pending drawing commands.

Contains the tag for drawing operations that caused errors or 0 if there were no errors. This parameter is passed uninitialized. Contains the tag for drawing operations that caused errors or 0 if there were no errors. This parameter is passed uninitialized.

Stops redirecting drawing operations to the layer that is specified by the last PushLayer call.

Adds the specified layer to the render target so that it receives all subsequent drawing operations until PopLayer is called.

The content bounds, geometric mask, opacity, opacity mask, and antialiasing options for the layer. The layer that receives subsequent drawing operations.

Creates a new bitmap render target for use during intermediate offscreen drawing that is compatible with the current render target .

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. When this method returns, contains the address of a pointer to a new bitmap render target. This parameter is passed uninitialized. The desired size of the new render target in device-independent pixels if it should be different from the original render target, or NULL. For more information, see the Remarks section. The desired size of the new render target in pixels if it should be different from the original render target, or NULL. For more information, see the Remarks section. The desired pixel format and alpha mode of the new render target, or NULL. If the pixel format is set to DXGI_FORMAT_UNKNOWN or if this parameter is null, the new render target uses the same pixel format as the original render target. If the alpha mode is D2D1_ALPHA_MODE_UNKNOWN or this parameter is NULL, the alpha mode of the new render target defaults to D2D1_ALPHA_MODE_PREMULTIPLIED. For information about supported pixel formats, see Supported Pixel Formats and Alpha Modes. A value that specifies whether the new render target must be compatible with GDI.

Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space.

The transform to apply to the render target.

Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space.

The transform to apply to the render target.

Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space.

The transform to apply to the render target.

Retrieves the render target's current text rendering options.

When this method returns, textRenderingParamscontains the address of a pointer to the render target's current text rendering options.

Specifies text rendering options to be applied to all subsequent text and glyph drawing operations.

The text rendering options to be applied to all subsequent text and glyph drawing operations; NULL to clear current text rendering options.

Gets the current antialiasing mode for text and glyph drawing operations.

Current antialiasing mode for text and glyph drawing operations.

Specifies the antialiasing mode to use for subsequent text and glyph drawing operations.

The antialiasing mode to use for subsequent text and glyph drawing operations.

Retrieves the current antialiasing mode for nontext drawing operations.

Current antialiasing mode for nontext drawing operations.

Sets the antialiasing mode of the render target. The antialiasing mode applies to all subsequent drawing operations, excluding text and glyph drawing operations.

The antialiasing mode for future drawing operations.

Paints the interior of the specified mesh.

The mesh to paint. The brush used to paint the mesh.

Draws the specified glyphs.

The origin, in device-independent pixels, of the glyphs' baseline. The glyphs to render. The brush used to paint the specified glyphs. A value that indicates how glyph metrics are used to measure text when it is formatted. The default value is DWRITE_MEASURING_MODE_NATURAL.

Paints the interior of the specified geometry.

The geometry to paint. The brush used to paint the geometry's interior. The opacity mask to apply to the geometry;NULL for no opacity mask. If an opacity mask (the opacityBrush parameter) is specified, brush must be an ID2D1BitmapBrush that has its x- and y-extend modes set to D2D1_EXTEND_MODE_CLAMP. For more information, see the Remarks section.

Draws the outline of the specified geometry using the specified stroke style.

The geometry to draw. The brush used to paint the geometry's stroke. The thickness of the geometry's stroke. The stroke is centered on the geometry's outline. The style of stroke to apply to the geometry's outline, or NULL to paint a solid stroke.

Draws the formatted text described by the specified IDWriteTextLayout object.

The bitmap to render. The size and position, in device-independent pixels in the render target's coordinate space, of the area to which the bitmap is drawn. If the rectangle is not well-ordered, nothing is drawn, but the render target does not enter an error state. A value between 0.0f and 1.0f, inclusive, that specifies an opacity value to apply to the bitmap; this value is multiplied against the alpha values of the bitmap's contents. The interpolation mode to use if the bitmap is scaled or rotated by the drawing operation. The size and position, in device-independent pixels in the bitmap's coordinate space, of the area within the bitmap to draw.

Draws the formatted text described by the specified IDWriteTextLayout object.

The point, described in device-independent pixels, at which the upper-left corner of the text described by textLayout is drawn. The formatted text to draw. Any drawing effects that do not inherit from ID2D1Resource are ignored. If there are drawing effects that inherit from ID2D1Resource that are not brushes, this method fails and the render target is put in an error state. The brush used to paint any text in textLayout that does not already have a brush associated with it as a drawing effect (specified by the IDWriteTextLayout::SetDrawingEffect method). A value that indicates whether the text should be snapped to pixel boundaries and whether the text should be clipped to the layout rectangle. The default value is D2D1_DRAW_TEXT_OPTIONS_NONE, which indicates that text should be snapped to pixel boundaries and it should not be clipped to the layout rectangle.

Draws the specified text using the format information provided by an IDWriteTextFormat object.

A pointer to an array of Unicode characters to draw. The size and position of the area in which the text is drawn. The brush used to paint the text. An object that describes formatting details of the text to draw, such as the font, the font size, and flow direction. A value that indicates whether the text should be snapped to pixel boundaries and whether the text should be clipped to the layout rectangle. The default value is D2D1_DRAW_TEXT_OPTIONS_NONE, which indicates that text should be snapped to pixel boundaries and it should not be clipped to the layout rectangle. A value that indicates how glyph metrics are used to measure text when it is formatted. The default value is DWRITE_MEASURING_MODE_NATURAL.

Applies the opacity mask described by the specified bitmap to a brush and uses that brush to paint a region of the render target.

The position and radius, in device-independent pixels, of the ellipse to paint. The brush used to paint the region of the render target specified by destinationRectangle. The type of content the opacity mask contains. The value is used to determine the color space in which the opacity mask is blended. The region of the render target to paint, in device-independent pixels. The region of the bitmap to use as the opacity mask, in device-independent pixels.

Draws a line between the specified points using the specified stroke style.

The start point of the line, in device-independent pixels. The end point of the line, in device-independent pixels. The brush used to paint the line's stroke. A value greater than or equal to 0.0f that specifies the width of the stroke. If this parameter isn't specified, it defaults to 1.0f. The stroke is centered on the line. The style of stroke to paint, or NULL to paint a solid line.

Paints the interior of the specified ellipse.

The position and radius, in device-independent pixels, of the ellipse to paint. The brush used to paint the interior of the ellipse.

Draws the outline of the specified ellipse using the specified stroke style.

The position and radius of the ellipse to draw, in device-independent pixels. The brush used to paint the ellipse's outline. The thickness of the ellipse's stroke. The stroke is centered on the ellipse's outline. The style of stroke to apply to the ellipse's outline, or NULL to paint a solid stroke.

Paints the interior of the specified rounded rectangle.

The dimensions of the rounded rectangle to paint, in device independent pixels. The brush used to paint the interior of the rounded rectangle.

Draws the outline of the specified rounded rectangle using the specified stroke style.

The dimensions of the rounded rectangle to draw, in device-independent pixels. The brush used to paint the rounded rectangle's outline. The width of the rounded rectangle's stroke. The stroke is centered on the rounded rectangle's outline. The default value is 1.0f. The style of the rounded rectangle's stroke, or NULL to paint a solid stroke. The default value is NULL.

Paints the interior of the specified rectangle.

The dimension of the rectangle to paint, in device-independent pixels. The brush used to paint the rectangle's interior.

Draws the outline of a rectangle that has the specified dimensions and stroke style.

The dimensions of the rectangle to draw, in device-independent pixels The brush used to paint the rectangle's stroke A value greater than or equal to 0.0f that specifies the width of the rectangle's stroke. The stroke is centered on the rectangle's outline. The style of stroke to paint, or NULL to paint a solid stroke.

Clears the drawing area to the specified color.

The color to which the drawing area is cleared.

Converts GDI color and alpha values to the D2D1_COLOR_F object.

RGB value. Alpha value. D2D1_COLOR_F value.

Ends drawing operations on the render target and indicates the current error state and associated tags.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Initiates drawing on this render target.

Detaches render target interface from the object

Pointer to detached render target interface.

Attaches existing render target interface to the object

Existing render target interface. Cannot be NULL

Gets the maximum size, in device-dependent units (pixels), of any one bitmap dimension supported by the render target

The maximum size, in pixels, of any one bitmap dimension supported by the render target

Indicates whether the render target supports the specified properties

TRUE if the specified render target properties are supported by this render target; otherwise, FALSE The render target properties to test

Specifies a label for subsequent drawing operations.

A label to apply to subsequent drawing operations. A label to apply to subsequent drawing operations.

Gets the label for subsequent drawing operations.

Contains the first label for subsequent drawing operations. This parameter is passed uninitialized. If NULL is specified, no value is retrieved for this parameter. Contains the second label for subsequent drawing operations. This parameter is passed uninitialized. If NULL is specified, no value is retrieved for this parameter.

Returns the size of the render target in device pixels

The size of the render target in device pixels

Retrieves the pixel format and alpha mode of the render target

The pixel format and alpha mode of the render target

Returns the render target's dots per inch (DPI)

The render target's dots per inch (DPI).

Sets the dots per inch (DPI) of the render target.

A value greater than or equal to zero that specifies the horizontal/verticalDPI of the render target.

Returns the size of the render target in device-independent pixels

The current size of the render target in device-independent pixels

Returns ID2D1RenderTarget interface

Pointer to an ID2D1RenderTarget interface or NULL if object is not initialized yet.

Returns ID2D1RenderTarget interface

Pointer to an ID2D1RenderTarget interface or NULL if object is not initialized yet.

Checks resource validity

TRUE if resource is valid; otherwise FALSE.

Deletes one or more resources

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE If bDeleteResources is TRUE, all resources located in m_lstResources will be automatically destroyed.

The destructor. Called when a render target object is being destroyed.

Constructs a CRenderTarget object.

ID2D1RenderTarget wrapper.

A pointer to an ID2D1Mesh.

Checks resource validity

TRUE if resource is valid; otherwise FALSE.

Destroys a CD2DMesh object.

Creates a CD2DMesh.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Opens the mesh for population.

A pointer to an ID2D1TessellationSink that is used to populate the mesh.

Returns ID2D1Mesh interface

Pointer to an ID2D1Mesh interface or NULL if object is not initialized yet.

Returns ID2D1Mesh interface

Pointer to an ID2D1Mesh interface or NULL if object is not initialized yet.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

The destructor. Called when a D2D mesh object is being destroyed.

Constructs a CD2DMesh object.

A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1Mesh wrapper.

A pointer to an ID2D1GeometrySink.

Specifies stroke and join options to be applied to new segments added to the geometry sink.

Stroke and join options to be applied to new segments added to the geometry sink.

Specifies the method used to determine which points are inside the geometry described by this geometry sink and which points are outside.

The method used to determine whether a given point is part of the geometry.

Closes the geometry sink

Nonzero if successful; otherwise FALSE.

Creates a sequence of lines using the specified points and adds them to the geometry sink.

An array of one or more points that describe the lines to draw. A line is drawn from the geometry sink's current point (the end point of the last segment drawn or the location specified by BeginFigure) to the first point in the array. if the array contains additional points, a line is drawn from the first point to the second point in the array, from the second point to the third point, and so on. An array of a sequence of the end points of the lines to draw.

Creates a line segment between the current point and the specified end point and adds it to the geometry sink.

The end point of the line to draw.

Adds a sequence of quadratic Bezier segments as an array in a single call.

An array of a sequence of quadratic Bezier segments.

Creates a quadratic Bezier curve between the current point and the specified end point.

A structure that describes the control point and the end point of the quadratic Bezier curve to add.

Creates a sequence of cubic Bezier curves and adds them to the geometry sink.

An array of Bezier segments that describes the Bezier curves to create. A curve is drawn from the geometry sink's current point (the end point of the last segment drawn or the location specified by BeginFigure) to the end point of the first Bezier segment in the array. if the array contains additional Bezier segments, each subsequent Bezier segment uses the end point of the preceding Bezier segment as its start point.

Creates a cubic Bezier curve between the current point and the specified end point.

A structure that describes the control points and end point of the Bezier curve to add.

Adds a single arc to the path geometry

The arc segment to add to the figure

Ends the current figure; optionally, closes it.

A value that indicates whether the current figure is closed. If the figure is closed, a line is drawn between the current point and the start point specified by BeginFigure.

Starts a new figure at the specified point.

The point at which to begin the new figure. Whether the new figure should be hollow or filled.

Returns ID2D1GeometrySink interface

Pointer to an ID2D1GeometrySink interface or NULL if object is not initialized yet.

Returns ID2D1GeometrySink interface

Pointer to an ID2D1GeometrySink interface or NULL if object is not initialized yet.

Checks geometry sink validity

TRUE if geometry sink is valid; otherwise FALSE.

The destructor. Called when a D2D geometry sink object is being destroyed.

Constructs a CD2DGeometrySink object from CD2DPathGeometry object.

An existing CD2DPathGeometry object.

ID2D1GeometrySink wrapper.

A pointer to an ID2D1PathGeometry.

Retrieves tthe number of figures in the path geometry.

Returns the number of figures in the path geometry.

Retrieves the number of segments in the path geometry.

Returns the number of segments in the path geometry.

Copies the contents of the path geometry to the specified ID2D1GeometrySink.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The sink to which the path geometry's contents are copied. Modifying this sink does not change the contents of this path geometry.

Retrieves the geometry sink that is used to populate the path geometry with figures and segments.

A pointer to the ID2D1GeometrySink that is used to populate the path geometry with figures and segments.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

Destroys a CD2DPathGeometry object.

Creates a CD2DPathGeometry.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Constructs a CD2DPathGeometry object.

A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1PathGeometry wrapper.

A pointer to an ID2D1Geometry.

Widens the geometry by the specified stroke and writes the result to an ID2D1SimplifiedGeometrySink after it has been transformed by the specified matrix and flattened using the specified tolerance.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The amount by which to widen the geometry. The style of stroke to apply to the geometry, or NULL. The transform to apply to the geometry after widening it. The ID2D1SimplifiedGeometrySink to which the widened geometry is appended. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.

Creates a set of clockwise-wound triangles that cover the geometry after it has been transformed using the specified matrix and flattened using the specified tolerance.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to this geometry, or NULL. The ID2D1TessellationSink to which the tessellated is appended. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.

Creates a simplified version of the geometry that contains only lines and (optionally) cubic Bezier curves and writes the result to an ID2D1SimplifiedGeometrySink.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. A value that specifies whether the simplified geometry should contain curves. The transform to apply to the simplified geometry. The ID2D1SimplifiedGeometrySink to which the simplified geometry is appended. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.

Computes the outline of the geometry and writes the result to an ID2D1SimplifiedGeometrySink.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to the geometry outline. The ID2D1SimplifiedGeometrySink to which the geometry transformed outline is appended. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.

Determines whether the geometry's stroke contains the specified point given the specified stroke thickness, style, and transform.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The point to test for containment. The thickness of the stroke to apply. The style of the stroke to apply. The transform to apply to the stroked geometry. When this method returns, contains a boolean value set to TRUE if the geometry's stroke contains the specified point; otherwise, FALSE. You must allocate storage for this parameter. The numeric accuracy with which the precise geometric path and path intersection is calculated. Points missing the stroke by less than the tolerance are still considered inside. Smaller values produce more accurate results but cause slower execution.

Indicates whether the area filled by the geometry would contain the specified point given the specified flattening tolerance.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The point to test. The transform to apply to the geometry prior to testing for containment. When this method returns, contains a bool value that is TRUE if the area filled by the geometry contains point; otherwise, FALSE. You must allocate storage for this parameter. The numeric accuracy with which the precise geometric path and path intersection is calculated. Points missing the fill by less than the tolerance are still considered inside. Smaller values produce more accurate results but cause slower execution.

Gets the bounds of the geometry after it has been widened by the specified stroke width and style and transformed by the specified matrix.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The amount by which to widen the geometry by stroking its outline. The style of the stroke that widens the geometry. A transform to apply to the geometry after the geometry is transformed and after the geometry has been stroked. When this method returns, contains the bounds of the widened geometry. You must allocate storage for this parameter. The maximum bounds on the distance between points in the polygonal approximation of the geometries. Smaller values produce more accurate results but cause slower execution.

Retrieves the bounds of the geometry.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to this geometry before calculating its bounds. When this method returns, contains the bounds of this geometry. If the bounds are empty, this will be a rect where bounds.left is greater than bounds.right. You must allocate storage for this parameter.

Calculates the point and tangent vector at the specified distance along the geometry after it has been transformed by the specified matrix and flattened using the specified tolerance.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The distance along the geometry of the point and tangent to find. If this distance is less then 0, this method calculates the first point in the geometry. If this distance is greater than the length of the geometry, this method calculates the last point in the geometry. The transform to apply to the geometry before calculating the specified point and tangent. The location at the specified distance along the geometry. If the geometry is empty, this point contains NaN as its x and y values. When this method returns, contains a pointer to the tangent vector at the specified distance along the geometry. If the geometry is empty, this vector contains NaN as its x and y values. You must allocate storage for this parameter. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.

Calculates the length of the geometry as though each segment were unrolled into a line.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to the geometry before calculating its length. When this method returns, contains a pointer to the length of the geometry. For closed geometries, the length includes an implicit closing segment. You must allocate storage for this parameter. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.

Computes the area of the geometry after it has been transformed by the specified matrix and flattened using the specified tolerance.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The transform to apply to this geometry before computing its area. When this method returns, contains a pointer to the area of the transformed, flattened version of this geometry. You must allocate storage for this parameter. The maximum bounds on the distance between points in the polygonal approximation of the geometry. Smaller values produce more accurate results but cause slower execution.

Describes the intersection between this geometry and the specified geometry. The comparison is performed using the specified flattening tolerance.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The geometry to test. The transform to apply to inputGeometry. The maximum bounds on the distance between points in the polygonal approximation of the geometries. Smaller values produce more accurate results but cause slower execution.

Combines this geometry with the specified geometry and stores the result in an ID2D1SimplifiedGeometrySink.

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE. The geometry to combine with this instance. The type of combine operation to perform. The transform to apply to inputGeometry before combining. The result of the combine operation. The maximum bounds on the distance between points in the polygonal approximation of the geometries. Smaller values produce more accurate results but cause slower execution.

Checks resource validity

TRUE if resource is valid; otherwise FALSE.

Destroys a CD2DGeometry object.

Returns ID2D1Geometry interface

Pointer to an ID2D1Geometry interface or NULL if object is not initialized yet.

Returns ID2D1Geometry interface

Pointer to an ID2D1Geometry interface or NULL if object is not initialized yet.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

The destructor. Called when a D2D geometry object is being destroyed.

Constructs a CD2DGeometry object.

A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1Geometry wrapper.

A pointer to an IDWriteTextLayout.

Gets the locale name of the text at the specified position.

CString object that contains the current locale name. The position of the text to inspect. The range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the locale name.

Copies the font family name of the text at the specified position.

CString object that contains the current font family name. The position of the text to examine. The range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the font family name.

Sets the locale name for text within a specified text range

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE A null-terminated locale name string Text range to which this change applies

Sets null-terminated font family name for text within a specified text range

If the method succeeds, it returns TRUE. Otherwise, it returns FALSE The font family name that applies to the entire text string within the range specified by textRange Text range to which this change applies

Returns IDWriteTextLayout interface

Pointer to an IDWriteTextLayout interface or NULL if object is not initialized yet.

Returns IDWriteTextLayout interface

Pointer to an IDWriteTextLayout interface or NULL if object is not initialized yet.

Checks resource validity

TRUE if resource is valid; otherwise FALSE.

Destroys a CD2DTextLayout object.

Creates a CD2DTextLayout.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Re-creates a CD2DTextLayout.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

The destructor. Called when a D2D text layout object is being destroyed.

Constructs a CD2DTextLayout object.

A pointer to the render target. A CString object that contains the string to create a new CD2DTextLayout object from. A CString object that contains the format to apply to the string. The size of the layout box. Indicates that the object will be destroyed by owner (pParentTarget).

IDWriteTextLayout wrapper.

A pointer to an IDWriteTextFormat.

Gets a copy of the locale name.

CString object that contains the current locale name.

Gets a copy of the font family name.

CString object that contains the current font family name.

Returns IDWriteTextFormat interface

Pointer to an IDWriteTextFormat interface or NULL if object is not initialized yet.

Returns IDWriteTextFormat interface

Pointer to an IDWriteTextFormat interface or NULL if object is not initialized yet.

Checks resource validity

TRUE if resource is valid; otherwise FALSE.

Destroys a CD2DTextFormat object.

Creates a CD2DTextFormat.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Re-creates a CD2DTextFormat.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

The destructor. Called when a D2D text format object is being destroyed.

Constructs a CD2DTextFormat object.

A pointer to the render target. A CString object that contains the name of the font family. The logical size of the font in DIP ("device-independent pixel") units. A DIPequals 1/96 inch. A value that indicates the font weight for the text object. A value that indicates the font style for the text object. A value that indicates the font stretch for the text object. A CString object that contains the locale name. A pointer to a font collection object. When this is NULL, indicates the system font collection. Indicates that the object will be destroyed by owner (pParentTarget).

IDWriteTextFormat wrapper.

A pointer to an ID2D1RadialGradientBrush.

The center, gradient origin offset, and x-radius and y-radius of the brush's gradient.

Retrieves the y-radius of the gradient ellipse

The y-radius of the gradient ellipse. This value is expressed in the brush's coordinate space

Retrieves the x-radius of the gradient ellipse

The x-radius of the gradient ellipse. This value is expressed in the brush's coordinate space

Retrieves the offset of the gradient origin relative to the gradient ellipse's center

The offset of the gradient origin from the center of the gradient ellipse. This value is expressed in the brush's coordinate space

Retrieves the center of the gradient ellipse

The center of the gradient ellipse. This value is expressed in the brush's coordinate space

Specifies the y-radius of the gradient ellipse, in the brush's coordinate space

The y-radius of the gradient ellipse. This value is in the brush's coordinate space

Specifies the x-radius of the gradient ellipse, in the brush's coordinate space

The x-radius of the gradient ellipse. This value is in the brush's coordinate space

Specifies the offset of the gradient origin relative to the gradient ellipse's center

The offset of the gradient origin from the center of the gradient ellipse

Specifies the center of the gradient ellipse in the brush's coordinate space

The center of the gradient ellipse, in the brush's coordinate space

Returns ID2D1RadialGradientBrush interface

Pointer to an ID2D1RadialGradientBrush interface or NULL if object is not initialized yet.

Returns ID2D1RadialGradientBrush interface

Pointer to an ID2D1RadialGradientBrush interface or NULL if object is not initialized yet.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

Destroys a CD2DRadialGradientBrush object.

Creates a CD2DRadialGradientBrush.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

The destructor. Called when a D2D radial gradient brush object is being destroyed.

Constructs a CD2DLinearGradientBrush object.

A pointer to the render target. A pointer to an array of D2D1_GRADIENT_STOP structures. A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array. The center, gradient origin offset, and x-radius and y-radius of the brush's gradient. The space in which color interpolation between the gradient stops is performed. The behavior of the gradient outside the [0,1] normalized range. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1RadialGradientBrush wrapper.

A pointer to an ID2D1LinearGradientBrush.

The start and end points of the gradient.

Retrieves the ending coordinates of the linear gradient

The ending two-dimensional coordinates of the linear gradient, in the brush's coordinate space

Retrieves the starting coordinates of the linear gradient

The starting two-dimensional coordinates of the linear gradient, in the brush's coordinate space

Sets the ending coordinates of the linear gradient in the brush's coordinate space

The ending two-dimensional coordinates of the linear gradient, in the brush's coordinate space

Sets the starting coordinates of the linear gradient in the brush's coordinate space

The starting two-dimensional coordinates of the linear gradient, in the brush's coordinate space

Returns ID2D1LinearGradientBrush interface

Pointer to an ID2D1LinearGradientBrush interface or NULL if object is not initialized yet.

Returns ID2D1LinearGradientBrush interface

Pointer to an ID2D1LinearGradientBrush interface or NULL if object is not initialized yet.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

Destroys a CD2DLinearGradientBrush object.

Creates a CD2DLinearGradientBrush.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

The destructor. Called when a D2D linear gradient brush object is being destroyed.

Constructs a CD2DLinearGradientBrush object.

A pointer to the render target. A pointer to an array of D2D1_GRADIENT_STOP structures. A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array. The start and end points of the gradient. The space in which color interpolation between the gradient stops is performed. The behavior of the gradient outside the [0,1] normalized range. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1LinearGradientBrush wrapper.

A pointer to an array of D2D1_GRADIENT_STOP structures.

The behavior of the gradient outside the [0,1] normalized range.

The space in which color interpolation between the gradient stops is performed.

Array of the D2D1_GRADIENT_STOP structures.

Destroys a CD2DGradientBrush object.

The destructor. Called when a D2D gradient brush object is being destroyed.

Constructs a CD2DGradientBrush object.

A pointer to the render target. A pointer to an array of D2D1_GRADIENT_STOP structures. A value greater than or equal to 1 that specifies the number of gradient stops in the gradientStops array. The space in which color interpolation between the gradient stops is performed. The behavior of the gradient outside the [0,1] normalized range. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget).

The base class of CD2DLinearGradientBrush and CD2DRadialGradientBrush classes.

Bitmap brush properties.

Stores a pointer to an ID2D1BitmapBrush object.

Stores a pointer to a CD2DBitmap object.

Initializes the object

A pointer to the bitmap brush properties.

Destroys a CD2DBitmapBrush object.

Creates a CD2DBitmapBrush.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Gets the interpolation method used when the brush bitmap is scaled or rotated

The interpolation method used when the brush bitmap is scaled or rotated

Gets the method by which the brush vertically tiles those areas that extend past its bitmap

A value that specifies how the brush vertically tiles those areas that extend past its bitmap

Gets the method by which the brush horizontally tiles those areas that extend past its bitmap

A value that specifies how the brush horizontally tiles those areas that extend past its bitmap

Specifies the bitmap source that this brush uses to paint

The bitmap source used by the brush

Specifies the interpolation mode used when the brush bitmap is scaled or rotated

The interpolation mode used when the brush bitmap is scaled or rotated

Specifies how the brush vertically tiles those areas that extend past its bitmap

A value that specifies how the brush vertically tiles those areas that extend past its bitmap

Specifies how the brush horizontally tiles those areas that extend past its bitmap

A value that specifies how the brush horizontally tiles those areas that extend past its bitmap

Gets the bitmap source that this brush uses to paint

Pointer to an CD2DBitmap object or NULL if object is not initialized yet.

Returns ID2D1BitmapBrush interface

Pointer to an ID2D1BitmapBrush interface or NULL if object is not initialized yet.

Returns ID2D1BitmapBrush interface

Pointer to an ID2D1BitmapBrush interface or NULL if object is not initialized yet.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

The destructor. Called when a D2D bitmap brush object is being destroyed.

Constructs a CD2DBitmapBrush object from file.

A pointer to the render target. Pointer to a null-terminated string that contains the name of file. Destination size of the bitmap. A pointer to the extend modes and the interpolation mode of a bitmap brush. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget).

Constructs a CD2DBitmapBrush object from resource.

A pointer to the render target. The resource ID number of the resource. Pointer to a null-terminated string that contains the resource type. Destination size of the bitmap. A pointer to the extend modes and the interpolation mode of a bitmap brush. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget).

Constructs a CD2DBitmapBrush object.

A pointer to the render target. A pointer to the extend modes and the interpolation mode of a bitmap brush. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1BitmapBrush wrapper.

Brush solid color.

Stores a pointer to an ID2D1SolidColorBrush object.

Destroys a CD2DSolidColorBrush object.

Creates a CD2DSolidColorBrush.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Retrieves the color of the solid color brush

The color of this solid color brush

Specifies the color of this solid color brush

The color of this solid color brush

Returns ID2D1SolidColorBrush interface

Pointer to an ID2D1SolidColorBrush interface or NULL if object is not initialized yet.

Returns ID2D1SolidColorBrush interface

Pointer to an ID2D1SolidColorBrush interface or NULL if object is not initialized yet.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

The destructor. Called when a D2D solid brush object is being destroyed.

Constructs a CD2DSolidColorBrush object.

A pointer to the render target. The red, green, and blue values of the brush's color. The opacity of the brush's color. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget).

Constructs a CD2DSolidColorBrush object.

A pointer to the render target. The red, green, blue, and alpha values of the brush's color. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1SolidColorBrush wrapper.

Brush properties.

Stores a pointer to an ID2D1Brush object.

Gets the current transform of the render target

When this returns, contains the current transform of the render target. This parameter is passed uninitialized

Applies the specified transform to the render target, replacing the existing transformation. All subsequent drawing operations occur in the transformed space

The transform to apply to the render target

Gets the degree of opacity of this brush

A value between zero and 1 that indicates the opacity of the brush. This value is a constant multiplier that linearly scales the alpha value of all pixels filled by the brush. The opacity values are clamped in the range 0 to 1 before they are multiplied together

Sets the degree of opacity of this brush

Destroys a CD2DBrush object.

Returns ID2D1Brush interface

Pointer to an ID2D1Brush interface or NULL if object is not initialized yet.

Returns ID2D1Brush interface

Pointer to an ID2D1Brush interface or NULL if object is not initialized yet.

Checks resource validity

TRUE if resource is valid; otherwise FALSE.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

The destructor. Called when a D2D brush object is being destroyed.

Constructs a CD2DBrush object.

A pointer to the render target. A pointer to the opacity and transformation of a brush. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1Brush wrapper.

Initializes the object

Creates a CD2D_BRUSH_PROPERTIES structure

The transformation to apply to the brush The base opacity of the brush. The default value is 1.0.

Creates a CD2D_BRUSH_PROPERTIES structure

The base opacity of the brush. The default value is 1.0.

Creates a CD2D_BRUSH_PROPERTIES structure

D2D1_BRUSH_PROPERTIES wrapper.

TRUE if m_hBmpSrc should be destroyed; otherwise FALSE.

Source bitmap handle.

Bitmap destination size.

Botmap file path.

Resource type.

Bitmap resource ID.

Stores a pointer to an ID2D1Bitmap object.

Destroys a CD2DBitmap object.

Creates a CD2DBitmap.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Initializes the object

Returns ID2D1Bitmap interface

Pointer to an ID2D1Bitmap interface or NULL if object is not initialized yet.

Returns ID2D1Bitmap interface

Pointer to an ID2D1Bitmap interface or NULL if object is not initialized yet.

Checks resource validity

TRUE if resource is valid; otherwise FALSE.

Copies the specified region from memory into the current bitmap

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. The data to copy The stride, or pitch, of the source bitmap stored in srcData. The stride is the byte count of a scanline (one row of pixels in memory). The stride can be computed from the following formula: pixel width * bytes per pixel + memory padding In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied

Copies the specified region from the specified render target into the current bitmap

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. The render target that contains the region to copy In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied The area of renderTarget to copy

Copies the specified region from the specified bitmap into the current bitmap

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. The bitmap to copy from In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied The area of bitmap to copy

Return the dots per inch (DPI) of the bitmap

The horizontal and vertical DPI of the bitmap.

Retrieves the pixel format and alpha mode of the bitmap

The pixel format and alpha mode of the bitmap.

Returns the size, in device-dependent units (pixels), of the bitmap

The size, in pixels, of the bitmap..

Returns the size, in device-independent pixels (DIPs), of the bitmap

The size, in DIPs, of the bitmap.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

The destructor. Called when a D2D bitmap object is being destroyed.

Constructs a CD2DBitmap object.

A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget).

Constructs a CD2DBitmap object from HBITMAP.

A pointer to the render target. Handle to the bitmap. Destination size of the bitmap. Indicates that the object will be destroyed by owner (pParentTarget).

Constructs a CD2DBitmap object from file.

A pointer to the render target. Pointer to a null-terminated string that contains the name of file. Destination size of the bitmap. Indicates that the object will be destroyed by owner (pParentTarget).

Constructs a CD2DBitmap object from resource.

A pointer to the render target. The resource ID number of the resource. Pointer to a null-terminated string that contains the resource type. Destination size of the bitmap. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1Bitmap wrapper.

Stores a pointer to an ID2D1Layer object.

Destroys a CD2DLayer object.

Creates a CD2DLayer.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Detaches resource interface from the object

Pointer to detached resource interface.

Attaches existing resource interface to the object

Existing resource interface. Cannot be NULL

Returns ID2D1Layer interface

Pointer to an ID2D1Layer interface or NULL if object is not initialized yet.

Returns ID2D1Layer interface

Pointer to an ID2D1Layer interface or NULL if object is not initialized yet.

Checks resource validity

TRUE if resource is valid; otherwise FALSE.

Returns the size of the render target in device-independent pixels

The current size of the render target in device-independent pixels

The destructor. Called when a D2D layer object is being destroyed.

Constructs a CD2DLayer object.

A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget).

ID2D1Layer wrapper.

Pointer to the parent CRenderTarget)

Resource will be destoyed by owner (CRenderTarget)

Checks resource validity

TRUE if resource is valid; otherwise FALSE.

Destroys a CD2DResource object.

Creates a CD2DResource.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Re-creates a CD2DResource.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to the render target.

Check auto destroy flag.

TRUE if the object will be destroyed by its owner; otherwise FALSE.

The destructor. Called when a D2D resource object is being destroyed.

Constructs a CD2DResource object.

A pointer to the render target. Indicates that the object will be destroyed by owner (pParentTarget).

An abstract class, which provides a interface for creating and managing D2D resources such as brushes, layers and texts.

Constructs a CD2DEllipse from CD2DPointF and CD2DSizeF objects.

The center point of the ellipse. The X-radius and Y-radius of the ellipse.

Constructs a CD2DEllipse object from D2D1_ELLIPSE object.

source ellipse

Constructs a CD2DEllipse object from D2D1_ELLIPSE object.

source ellipse

Constructs a CD2DEllipse object from CD2DRectF object.

source rectangle

D2D1_ELLIPSE wrapper

Constructs a CD2DRoundedRect object from D2D1_ROUNDED_RECT object.

source rectangle

Constructs a CD2DRoundedRect object from D2D1_ROUNDED_RECT object.

source rectangle

Constructs a CD2DRoundedRect object from CD2DRectF object.

source rectangle radius size

D2D1_ROUNDED_RECT wrapper

Converts CD2DRectU to CRect object.

Current value of D2D rectangle.

Returns a Boolean value that indicates whether an expression contains no valid data (Null).

TRUE if rectangle's top, left, bottom, and right values are all equal to 0; otherwise FALSE.

Constructs a CD2DRectU object from four UINT32 values.

source left coordinate source top coordinate source right coordinate source bottom coordinate

Constructs a CD2DRectU object from D2D1_RECT_U object.

source rectangle

Constructs a CD2DRectU object from D2D1_RECT_U object.

source rectangle

Constructs a CD2DRectU object from CRect object.

source rectangle

D2D1_RECT_U wrapper

Converts CD2DRectF to CRect object.

Current value of D2D rectangle.

Returns a Boolean value that indicates whether an expression contains no valid data (Null).

TRUE if rectangle's top, left, bottom, and right values are all equal to 0; otherwise FALSE.

Constructs a CD2DRectF object from four FLOAT values.

source left coordinate source top coordinate source right coordinate source bottom coordinate

Constructs a CD2DRectF object from D2D1_RECT_F object.

source rectangle

Constructs a CD2DRectF object from D2D1_RECT_F object.

source rectangle

Constructs a CD2DRectF object from CRect object.

source rectangle

D2D1_RECT_F wrapper

Converts CD2DSizeU to CSize object.

Current value of D2D size.

Returns a Boolean value that indicates whether an expression contains no valid data (Null).

TRUE if width and height are empty; otherwise FALSE.

Constructs a CD2DSizeU object from two UINT32 values.

source width source height

Constructs a CD2DSizeU object from D2D1_SIZE_U object.

source size

Constructs a CD2DSizeU object from D2D1_SIZE_U object.

source size

Constructs a CD2DSizeU object from CSize object.

source size

D2D1_SIZE_U wrapper

Converts CD2DSizeF to CSize object.

Current value of D2D size.

Returns a Boolean value that indicates whether an expression contains no valid data (Null).

TRUE if width and height are empty; otherwise FALSE.

Constructs a CD2DSizeF object from two FLOAT values.

source width source height

Constructs a CD2DSizeF object from D2D1_SIZE_F object.

source size

Constructs a CD2DSizeF object from D2D1_SIZE_F object.

source size

Constructs a CD2DSizeF object from CSize object.

source size

D2D1_SIZE_F wrapper

Converts CD2DPointU to CPoint object.

Current value of D2D point.

Constructs a CD2DPointU object from two UINT32 values.

source X source Y

Constructs a CD2DPointU from object D2D1_POINT_2U object.

source point

Constructs a CD2DPointU from object D2D1_POINT_2U object.

source point

Constructs a CD2DPointU object from CPoint object.

source point

D2D1_POINT_2U wrapper

Converts CD2DPointF to CPoint object.

Current value of D2D point.

Constructs a CD2DPointF object from two FLOAT values.

source X source Y

Constructs a CD2DPointF object from D2D1_POINT_2F object.

source point

Constructs a CD2DPointF object from D2D1_POINT_2F object.

source point

Constructs a CD2DPointF object from CPoint object.

source point

D2D1_POINT_2F wrapper

Calls the transition library to create encapsulated transition COM object.

This method also can set initial value and initial velocity to be applied to an animation variable, which is associated with this transition. For this purpose you have to call SetInitialValue and SetInitialVelocity before the framework creates the encapsulated transition COM object (it happens when you call CAnimationController::AnimateGroup). A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions.

Sets an initial velocity, which will be applied to an animation variable associated with this transition.

Sets an initial value, which will be applied to an animation variable associated with this transition.

Constructs a custom transition object.

A pointer to custom interpolator.

Stores the initial velocity.

Stores the initial value.

Specifies whether the initial velocity was specified with SetInitialVelocity.

Specifies whether the initial value was specified with SetInitialValue.

Stores a pointer to a custom interpolator.

Implements custom transition.

The CCustomTransitions class allows developers to implement custom transitions. It's created and used as a standard transition, but its constructor accepts as parameter a pointer to a custom interpolator. Perform the following steps to use custom transitions: 1. Derive a class from CCustomInterpolator and implement at least InterpolateValue method. 2. Ensure that the lifetime of custom interpolator object must be longer than duration of animation where it's used. 3. Instantiate (using operator new) a CCustomTransition object and pass a pointer to custom interpolator in the constructor. 4. Call CCustomTransition::SetInitialValue and CCustomTransition::SetInitialVelocity if these parameters are required for custom interpolation. 5. Pass the pointer to custom transition to AddTransition method of animation object, whose value should be animated with the custom algorithm. 6. When the value of animation object should change Windows Animation API will call InterpolateValue (and other relevant methods) in CCustomInterpolator.

Gets the interpolator's dependencies.

If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the GetDependencies method. Output. Aspects of the interpolator that depend on the initial value passed to SetInitialValueAndVelocity. Output. Aspects of the interpolator that depend on the initial velocity passed to SetInitialValueAndVelocity. Output. Aspects of the interpolator that depend on the duration passed to SetDuration.

Interpolates the velocity at a given offset

If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the InterpolateVelocity method. The offset from the start of the transition. The offset is always greater than or equal to zero and less than or equal to the duration of the transition. This method is not called if the duration of the transition is zero. Output. The velocity of the variable at the offset.

Interpolates the value at a given offset

If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the InterpolateValue method. The offset from the start of the transition. The offset is always greater than or equal to zero and less than the duration of the transition. This method is not called if the duration of the transition is zero. Output. The interpolated value.

Gets the final value to which the interpolator leads.

If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the GetFinalValue method. Output. The final value of a variable at the end of the transition.

Gets the interpolator's duration.

If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the GetDuration method. Output. The duration of the transition, in seconds.

Sets the interpolator's duration

If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the SetDuration method. The duration of the transition.

Sets the interpolator's initial value and velocity.

If the method succeeds, it returns S_OK. It returns E_FAIL if CCustomInterpolator is not set, or custom implementation returns FALSE from the SetInitialValueAndVelocity method. The value of the variable at the start of the transition. The velocity of the variable at the start of the transition.

Creates an instance of CInterpolatorBase and stores a pointer to custom interpolator, which will be handling events.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to custom interpolator.Output. Contains a pointer to instance of CInterpolatorBase when the function returns.

Stores a pointer to custom interpolator, which will be handling events.

A pointer to custom interpolator.

Constructs the CInterpolatorBase object.

Implements a callback, which is called by Animation API when it needs to calculate a new value of animation variable.

This handler is created and passed to IUIAnimationTransitionFactory::CreateTransition when a CCustomTransition object is being created as a part of animation initialization process (started by CAnimationController::AnimateGroup). Usually you don't need to use this class directly, it just routs all events to a CCustomInterpolator-derived class, whose pointer is passed to constructor of CCustomTransition.

Gets the interpolator's dependencies.

Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. Output. Aspects of the interpolator that depend on the initial value passed to SetInitialValueAndVelocity. Output. Aspects of the interpolator that depend on the initial velocity passed to SetInitialValueAndVelocity. Output. Aspects of the interpolator that depend on the duration passed to SetDuration.

Interpolates the velocity at a given offset

Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. The offset from the start of the transition. The offset is always greater than or equal to zero and less than or equal to the duration of the transition. This method is not called if the duration of the transition is zero. Output. The velocity of the variable at the offset.

Interpolates the value at a given offset.

Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. The offset from the start of the transition. The offset is always greater than or equal to zero and less than the duration of the transition. This method is not called if the duration of the transition is zero. Output. The interpolated value.

Gets the final value to which the interpolator leads.

Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. Output. The final value of a variable at the end of the transition.

Gets the interpolator's duration.

Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. Output. The duration of the transition, in seconds.

Sets the interpolator's duration.

Basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. The duration of the transition.

Sets the interpolator's initial value and velocity.

The basic implementation always returns TRUE. Return FALSE from overridden implementation if you wish to fail the event. The value of the variable at the start of the transition. The velocity of the variable at the start of the transition.

Initializes duration and final value.

The duration of the transition. The final value of a variable at the end of the transition.

Constructs a custom interpolator object and initializes duration and velocity to specified values.

The duration of the transition.

Constructs a custom interpolator object and sets all values to default 0.

Use CCustomInterpolator::Init to initialize duration and final value later in the code.

The interpolated velocity.

The interpolated value.

The velocity of the variable at the start of the transition.

The value of the variable at the start of the transition.

The final value of a variable at the end of the transition.

The duration of the transition.

Implements a basic interpolator.

Derive a class from CCustomInterpolator and override all necessary methods in order to implement a custom interpolation algorithm. A pointer to this class should be passed as a parameter to CCustomTransition.

Calls the transition library to create encapsulated transition COM object.

TRUE if transition is created successfully; otherwise FALSE. A pointer to transition library, which is responsible for creation of standard transitions. A pointer to transition factory, which is responsible for creation of custom transitions.

The period of oscillation of the sinusoidal wave in seconds.

The duration of the transition.

Constructs a transition object.

The duration of the transition. The period of oscillation of the sinusoidal wave in seconds.

Encapsulates a sinusoidal-velocity transition, with an amplitude determined by the animation variable's initial velocity..

The value of the animation variable oscillates around the initial value over the entire duration of a sinusoidal-range transition. The amplitude of the oscillation is determined by the animation variable's velocity when the transition begins. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The slope at the start of the transition.

The period of oscillation of the sinusoidal wave in seconds.

The value of the animation variable at a peak of the sinusoidal wave.

The value of the animation variable at a trough of the sinusoidal wave.

The duration of the transition.

Constructs a transition object.

The duration of the transition. The value of the animation variable at a trough of the sinusoidal wave. The value of the animation variable at a peak of the sinusoidal wave. The period of oscillation of the sinusoidal wave in seconds. The slope at the start of the transition.

Encapsulates a sinusoidal-range transition, with a given range of oscillation.

The value of the animation variable fluctuates between the specified minimum and maximum values over the entire duration of a sinusoidal-range transition. The slope parameter is used to disambiguate between the two possible sine waves specified by the other parameters. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The duration of the transition.

Constructs a reversal transition object and initializes its duration.

The duration of the transition.

Encapsulates a reversal transition.

A reversal transition smoothly changes direction over a given duration. The final value will be the same as the initial value and the final velocity will be the negative of the initial velocity. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The acceleration of the animation variable during the transition.

The velocity of the animation variable at the end of the transition.

The value of the animation variable at the end of the transition.

Constructs a parabolic-acceleration transition and initializes it with specified parameters.

The value of the animation variable at the end of the transition. The velocity of the animation variable at the end of the transition. The acceleration of the animation variable during the transition.

Encapsulates a parabolic-acceleration transition.

During a parabolic-acceleration transition, the value of the animation variable changes from the initial value to the final value ending at a specified velocity. You can control how quickly the variable reaches the final value by specifying the rate of acceleration. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The value of the animation variable at the end of the transition.

The maximum duration of the transition.

Constructs a smooth-stop transition and initializes its maximum duration and final value.

The maximum duration of the transition. The value of the animation variable at the end of the transition.

Encapsulates a smooth-stop transition.

A smooth-stop transition slows down as it approaches a given final value, and reaches it with a velocity of zero. The duration of the transition is determined by the initial velocity, the difference between the initial and final values, and the specified maximum duration. If there is no solution consisting of a single parabolic arc, this method creates a cubic transition. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The value of the animation variable at the end of the transition.

The absolute value of the variable's velocity.

Constructs a linear-speed transition object and initializes it with speed and final value.

The absolute value of the variable's velocity. The value of the animation variable at the end of the transition.

Encapsulates a linear-speed transition.

During a linear-speed transition, the value of the animation variable changes at a specified rate. The duration of the transition is determined by the difference between the initial value and the specified final value. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The value of the animation variable at the end of the transition.

The duration of the transition.

Constructs a linear transition object and initializes it with duration and final value.

The duration of the transition. The value of the animation variable at the end of the transition.

Encapsulates a linear transition.

During a linear transition, the value of the animation variable transitions linearly from its initial value to a specified final value. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The value of the animation variable at the end of the transition.

Constructs a transition object and initializes its final value.

The value of the animation variable at the end of the transition.

Encapsulates an instantaneous transition.

During an instantaneous transition, the value of the animation variable changes instantly from its current value to a specified final value. The duration of this transition is always zero. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The amount of time by which to hold the variable at its final value.

The value of the animation variable at the end of the transition.

The amount of time by which to delay the instantaneous switch to the final value.

Constructs a discrete transition object and initializes its parameters.

The amount of time by which to delay the instantaneous switch to the final value. The value of the animation variable at the end of the transition. The amount of time by which to hold the variable at its final value.

Encapsulates a discrete transition.

During a discrete transition, the animation variable remains at the initial value for a specified delay time, then switches instantaneously to a specified final value and remains at that value for a given hold time. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The velocity of the variable at the end of the transition.

The value of the animation variable at the end of the transition.

The duration of the transition.

Constructs a transition object and initializes its parameters.

The duration of the transition. The value of the animation variable at the end of the transition. The velocity of the variable at the end of the transition.

Encapsulates a cubic transition.

During a cubic transition, the value of the animation variable changes from its initial value to a specified final value over the duration of the transition, ending at a specified velocity. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The duration of the transition.

Constructs a transition object and initializes its duration.

The duration of the transition.

Encapsulates a constant transition.

During a constant transition, the value of an animation variable remains at the initial value over the duration of the transition. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Calls the transition library to create encapsulated transition COM object.

The ratio of the time spent decelerating to the duration.

The ratio of the time spent accelerating to the duration.

The value of the animation variable at the end of the transition.

The duration of the transition.

Constructs a transition object.

The duration of the transition. The value of the animation variable at the end of the transition. The ratio of the time spent accelerating to the duration. The ratio of the time spent decelerating to the duration.

Implements an accelerate-decelerate transition.

During an accelerate-decelerate transition, the animation variable speeds up and then slows down over the duration of the transition, ending at a specified value. You can control how quickly the variable accelerates and decelerates independently, by specifying different acceleration and deceleration ratios. When the initial velocity is zero, the acceleration ratio is the fraction of the duration that the variable will spend accelerating; likewise with the deceleration ratio. If the initial velocity is non-zero, it is the fraction of the time between the velocity reaching zero and the end of transition. The acceleration ratio and the deceleration ratio should sum to a maximum of 1.0. Because all transitions are cleared automatically, it's recommended to allocated them using operator new. The encapsulated IUIAnimationTransition COM object is created by CAnimationController::AnimateGroup, until then it's NULL. Changing member variables after creation of this COM object has no effect.

Handles events that occur when the rendering frame rate for an animation falls below the minimum desirable frame rate.

S_OK if the method succeeds; otherwise E_FAIL.

Handles events that occur after an animation update is finished.

S_OK if the method succeeds; otherwise E_FAIL.

Handles events that occur before an animation update begins.

S_OK if the method succeeds; otherwise E_FAIL.

Stores a pointer to animation controller to route events.

A pointer to animation controller, which will receive events.

Creates an instance of CAnimationTimerEventHandler callback.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. A pointer to animation controller, which will receive events. Output. If the method succeeds it contains a pointer to COM object that will handle animation timer events.

Implements a call back, which is called by Animation API when timing events occur.

This event handler is created and passed to IUIAnimationTimer::SetTimerEventHandler when you call CAnimationController::EnableAnimationTimerEventHandler.

Handles OnStoryboardUpdated events, which occur when a storyboard is updated

S_OK if the method succeeds; otherwise E_FAIL. A pointer to storyboard, which was updated.

Handles OnStoryboardStatusChanged events, which occur when a storyboard's status changes

S_OK if the method succeeds; otherwise E_FAIL. A pointer to storyboard whose status has changed. Specifies new storyboard status. Specifies previous storyboard status.

Stores a pointer to animation controller to route events.

A pointer to animation controller, which will receive events.

Creates an instance of CAnimationStoryboardEventHandler callback.

Constructs a CAnimationStoryboardEventHandler object.

Implements a callback, which is called by Animation API when storyboard's status is changed or storyboard is updated.

This event handler is created and passed to IUIAnimationStoryboard::SetStoryboardEventHandler method, when you call CAnimationController::EnableStoryboardEventHandler.

Called when a value of an animation variable has changed.

S_OK if the method succeeds; otherwise E_FAIL. The storyboard that is animating the variable. The animation variable that was updated. The new rounded value. The previous rounded value.

Stores a pointer to animation controller to route events.

A pointer to animation controller, which will receive events.

Creates an instance of CAnimationVariableIntegerChangeHandler callback.

Constructs a CAnimationVariableIntegerChangeHandler object.

Implements a call back, which is called by Animation API when the value of an animation variable changes.

This event handler is created and passed to IUIAnimationVariable::SetVariableIntegerChangeHandler method, when you call CAnimationVariable::EnableIntegerValueChangedEvent or CAnimationBaseObject::EnableIntegerValueChangedEvent (which enables this event for all animation variables encapsulated in an animation object).

Called when a value of an animation variable has changed.

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. The storyboard that is animating the variable. The animation variable that was updated. The new value. The previous value.

Stores a pointer to animation controller to route events.

A pointer to animation controller, which will receive events.

Creates an instance of CAnimationVariableChangeHandler object.

Constructs a CAnimationVariableChangeHandler object.

Implements a call back, which is called by Animation API when the value of an animation variable changes.

This event handler is created and passed to IUIAnimationVariable::SetVariableChangeHandler method, when you call CAnimationVariable::EnableValueChangedEvent or CAnimationBaseObject::EnableValueChangedEvent (which enables this event for all animation variables encapsulated in an animation object).

Called when a status of animation manager has changed.

Current implementation always returns S_OK; New status. Previous status.

Stores a pointer to animation controller to route events.

A pointer to animation controller, which will receive events.

Creates an instance of CAnimationManagerEventHandler object.

Constructs a CAnimationManagerEventHandler object.

Implements a callback, which is called by Animation API when a status of animation manager changed.

This event handler is created and passed to IUIAnimationManager::SetManagerEventHandler method, when you call CAnimationController::EnableAnimationManagerEvent.

A helper that cleans up the group.

This method removes all transitions and keyframes from the specified group. A pointer to animation group to clean.

Called by the framework when an animation for the specified group has just been scheduled.

The default implementation removes keyframes from the specified group and transitions from animation variables that belong to the specified group. Can be overridden in a derived class to take any additional actions upon animation schedule. A pointer to an animation group, which has been scheduled.

Called by the framework when the rendering frame rate for an animation falls below a minimum desirable frame rate.

This method is called if you enable timer event handlers using EnableAnimationTimerEventHandler. It can be overridden in a derived class to take application-specific actions. The minimum desirable frame rate is specified by calling IUIAnimationTimer::SetFrameRateThreshold. The current frame rate in frames per second.

Called by the framework after an animation update is finished.

This method is called if you enable timer event handlers using EnableAnimationTimerEventHandler. It can be overridden in a derived class to take application-specific actions.

Called by the framework before an animation update begins.

This method is called if you enable timer event handlers using EnableAnimationTimerEventHandler. It can be overridden in a derived class to take application-specific actions.

Called by the framework to resolve scheduling conflicts.

Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by pGroupScheduled has priority. This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler and specify UI_ANIMATION_PHT_COMPRESS. It can be overridden in a derived class to take application-specific actions. Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx). The group that owns the currently scheduled storyboard. The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled. The potential effect on pGroupNew if pGroupScheduled has a higher priority.

Called by the framework to resolve scheduling conflicts.

Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by pGroupScheduled has priority. This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler and specify UI_ANIMATION_PHT_TRIM. It can be overridden in a derived class to take application-specific actions. Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx). The group that owns the currently scheduled storyboard. The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled. The potential effect on pGroupNew if pGroupScheduled has a higher priority.

Called by the framework to resolve scheduling conflicts.

Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by pGroupScheduled has priority. This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler and specify UI_ANIMATION_PHT_CONCLUDE. It can be overridden in a derived class to take application-specific actions. Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx). The group that owns the currently scheduled storyboard. The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled. The potential effect on pGroupNew if pGroupScheduled has a higher priority.

Called by the framework to resolve scheduling conflicts.

Should return TRUE if storyboard owned by pGroupNew has priority. Should return FALSE if storyboard owned by pGroupScheduled has priority. This method is called if you enable priority comparison events using CAnimationController::EnablePriorityComparisonHandler and specify UI_ANIMATION_PHT_CANCEL. It can be overridden in a derived class to take application-specific actions. Read Windows Animation API documentation for more information about Conflict Management (http://msdn.microsoft.com/en-us/library/dd371759(VS.85).aspx). The group that owns the currently scheduled storyboard. The group that owns the new storyboard that is in scheduling conflict with the scheduled storyboard owned by pGroupScheduled. The potential effect on pGroupNew if pGroupScheduled has a higher priority.

Called by the framework when storyboard has been updated.

This method is called if you enable storyboard events using CAnimationController::EnableStoryboardEventHandler. It can be overridden in a derived class to take application-specific actions. A pointer to a group that owns the storyboard.

Called by the framework when storyboard status has changed.

Called by the framework when integer value of animation variable has changed.

This method is called if you enable animation variable events with EnableIntegerValueChangedEvent called for a specific animation variable or animation object. It can be overridden in a derived class to take application-specific actions. A pointer to an animation group that holds an animation object whose value has changed. A pointer to an animation object that contains an animation variable whose value has changed. A pointer to an animation variable. Specifies new value. Specifies previous value.

Called by the framework when value of animation variable has changed.

This method is called if you enable animation variable events with EnableValueChangedEvent called for a specific animation variable or animation object. It can be overridden in a derived class to take application-specific actions. A pointer to an animation group that holds an animation object whose value has changed. A pointer to an animation object that contains an animation variable whose value has changed. A pointer to an animation variable. Specifies new value. Specifies previous value.

Called by the framework in response to StatusChanged event from animation manager.

This method is called if you enable animation manager events with EnableAnimationManagerEvent. It can be overridden in a derived class to take application-specific actions. The default implementation updates a related window if it has been set with SetRelatedWnd. New animation manager status. Previous animation manager status.

Called by the framework right before the animation is scheduled.

This call is routed to related CWnd and can be overridden in a derived class to perform any additional actions before the animation starts for the specified group. A pointer to an animation group whose animation is about to start.

Called by the framework to clean up the group when animation has been scheduled.

This method removes all transitions and keyframes from the specified group, because they are not relevant after an animation has been scheduled. Specifies GroupID.

Schedules an animation.

TRUE if animation was scheduled successfully. FALSE if storyboard has not been created, or other error occurs. You must call AnimateGroup with parameter bScheduleNow set to FALSE prior ScheduleGroup. You can specify the desired animation time obtained from IUIAnimationTimer::GetTime. If the time parameter is 0.0, the animation is scheduled for the current time. Specifies animation Group ID to schedule. Specifies time to schedule.

Prepares a group to run animation and optionally schedules it.

TRUE if animation was successfully scheduled and run. This method does the actual work creating storyboard, adding animation variables, applying transitions and setting keyframes. It's possible to delay scheduling if you set bScheduleNow to FALSE. In this case the specified group will hold a storyboard that has been set up for animation. At that point you can setup events for the storyboard and animation variables. When you actually need to run the animation call CAnimationController::ScheduleGroup. Specifies GroupID. Specifies whether to run animation right away.

Finds animation object containing a specified animation variable.

TRUE if object was found; otherwise FALSE. Called from event handlers when it's required to find an animation object from incoming animation variable. A pointer to animation variable. Output. Contains a pointer to animation object or NULL. Output. Contains a pointer to animation group that holds the animation object, or NULL.

Finds an animation group by its storyboard.

A pointer to animation group if succeeds, or NULL if no group plays the specified storyboard. This method is usually called from event handlers to find a group by pointer to storyboard that comes as a parameter to an event handler. A pointer to a storyboard.

Finds an animation group by its Group ID.

A pointer to animation group or NULL if the group with specified ID is not found. Use this method to find an animation group at runtime. A group is created and added to the internal list of animation groups when a first animation object with particular GroupID is being added to animation controller. Specifies a GroupID.

Adds a keyframe to group.

TRUE if the function succeeds; otherwise FALSE. Usually you don't need to call this method, use CAnimationController::CreateKeyframe instead, which creates and adds the created keyframe to a group automatically. Specifies Group ID. A pointer to a keyframe.

Creates a keyframe that depends on other keyframe with optional offset in seconds and adds it to the specified group.

A pointer to newly created keyframe if the function succeeds. You can store the returned pointer and base other keyframes on the newly created keyframe (see the second overload). It's possible to begin transitions at keyframes - see CBaseTransition::SetKeyframes. You don't need to delete keyframes created in this way, because they are deleted automatically by animation groups. Be careful when creating keyframes based on other keyframes and transitions and avoid circular references. Specifies Group ID for which keyframe is created. A pointer to base keyframe for this keyframe. Offset in seconds from the base keyframe specified by pKeyframe.

Creates a keyframe that depends on transition and adds it to the specified group.

A pointer to newly created keyframe if the function succeeds. You can store the returned pointer and base other keyframes on the newly created keyframe (see the second overload). It's possible to begin transitions at keyframes - see CBaseTransition::SetKeyframes. You don't need to delete keyframes created in this way, because they are deleted automatically by animation groups. Be careful when creating keyframes based on other keyframes and transitions and avoid circular references. Specifies Group ID for which keyframe is created. A pointer to transition. Keyframe will be inserted to storyboard after this transition.

Removes transitions from animation objects that belong to the specified group.

The group loops over its animation objects and calls ClearTransitions(FALSE) for each animation object. This method is called by the framework after animation has been scheduled. Specifies Group ID.

Removes all animation groups from animation controller.

All groups will be deleted, their pointer, if stored at the application level, must be invalidated. If CAnimationGroup::m_bAutodestroyAnimationObjects for a group being deleted is TRUE, all animation objects that belong to that group will be deleted; otherwise their references to parent animation controller will be set to NULL and they can be added to another controller.

Removes an animation group with specified ID from animation controller.

This method removes an animation group from the internal list of groups and deletes it, therefore if you stored a pointer to that animation group, it must be invalidated. If CAnimationGroup::m_bAutodestroyAnimationObjects is TRUE, all animation objects that belong to that group will be deleted; otherwise their references to parent animation controller will be set to NULL and they can be added to another controller. Specifies animation group ID.

Remove an animation object from animation controller.

Removes an animation object from animation controller and animation group. Call this function if a particular object should not be animated anymore, or if you need to move the object to another animation controller. In the last case bNoDelete must be TRUE. A pointer to an animation object. If this parameter is TRUE the object will not be deleted upon remove.

Adds an animation object to a group that belongs to the animation controller.

A pointer to existing or new animation group where pObject has been added if function succeeds; NULL if pObject has already been added to a group that belongs to another animation controller. Call this method to add an animation object to the animation controller. An object will be added to a group according to object's GroupID (see CAnimationBaseObject::SetID). The animation controller will create a new group if it's the first object being added with the specified GroupID. An animation object can be added to one animation controller only. If you need to add an object to another controller, call RemoveAnimationObject first. If you call SetID with new GroupID for an object that has been already added to a group, the object will be removed from the old group and added to another group with specified ID. A pointer to an animation object.

Establishes a relationship between animation controller and a window.

If a related CWnd object is set, the animation controller can automatically update it (send WM_PAINT message) when the status of animation manager has changed or timer post update event has occurred. A pointer to window object to set.

Tells whether at least one group is playing animation.

TRUE if there is an animation in progress for this animation controller; otherwise FALSE. Checks status of animation manager and returns TRUE if the status is UI_ANIMATION_MANAGER_BUSY.

Directs the animation manager to update the values of all animation variables.

Calling this method advances the animation manager to current time, changing statuses of storyboards as necessary and updating any animation variables to appropriate interpolated values. Internally this method calls IUIAnimationTimer::GetTime(timeNow) and IUIAnimationManager::Update(timeNow). Override this method in a derived class to customize this behavior.

Sets or releases a handler for timing events and handler for timing updates.

TRUE if handlers were successfully set or released; FALSE if this method is called for a second time without releasing the handlers first, or if any other error occurs. When the handlers are set (enabled) Windows Animation API calls OnAnimationTimerPreUpdate, OnAnimationTimerPostUpdate, OnRenderingTooSlow methods. You need to enable animation timers to allow Windows Animation API update storyboards. Otherwise you'll need to call CAnimationController::UpdateAnimationManager in order to direct the animation manager to update the values of all animation variables. Specifies whether to set or release the handlers. Specifies idle behavior for timer update handler.

Sets or releases a handler for storyboard status and update events.

TRUE if the handler was successfully set or released; FALSE if the specified animation group is now found or animation for the specified group has not been initiated and its internal storyboard is NULL. When a handler is set (enabled) Windows Animation API calls OnStoryboardStatusChanges and OnStoryboardUpdated virtual methods. A handler must be set after CAnimationController::Animate has been called for the specified animation group, because it creates encapsulated IUIAnimationStoryboard object. Specifies Group ID. Specifies whether to set or release a handler.

Sets or releases the priority comparison handler to call to determine whether a scheduled storyboard can be cancelled, concluded, trimmed or compressed.

TRUE if the handler was successfully set or released. When a handler is set (enabled) Windows Animation calls the following virtual methods depending on dwHandlerType: OnHasPriorityCancel, OnHasPriorityConclude, OnHasPriorityTrim, OnHasPriorityCompress. dwHandler can be a combination of the following flags: UI_ANIMATION_PHT_NONE - release all handlers UI_ANIMATION_PHT_CANCEL - set Cancel comparison handler UI_ANIMATION_PHT_CONCLUDE - set Conclude comparison handler UI_ANIMATION_PHT_COMPRESS - set Compress comparison handler UI_ANIMATION_PHT_TRIM - set Trim comparison handler UI_ANIMATION_PHT_CANCEL_REMOVE - remove Cancel comparison handler UI_ANIMATION_PHT_CONCLUDE_REMOVE - remove Conclude comparison handler UI_ANIMATION_PHT_COMPRESS_REMOVE - remove Compress comparison handler UI_ANIMATION_PHT_TRIM_REMOVE - remove Trim comparison handler A combination of UI_ANIMATION_PHT_ flags (see remarks), which specifies what handlers to set or release.

Sets or releases a handler to call when animation manager's status changes.

TRUE if the handler was successfully set or released. When a handler is set (enabled) Windows Animation calls OnAnimationManagerStatusChanged when animation manager's status changes. Specifies whether to set or release a handler.

Returns a keyframe that identifies start of storyboard.

A pointer to base keyframe, which identifies start of storyboard. Obtain this keyframe to base any other keyframes or transitions on the moment in time when a storyboard starts.

Tells whether animation controller is valid.

TRUE if animation controller is valid; otherwise FALSE. This method returns FALSE only if Windows Animation API is not supported on the current OS and creation of animation manager failed because it's not registered. You need to call GetUIAnimationManager at least once after initialization of COM libraries to cause setting of this flag.

A pointer to IUIAnimationTransitionFactory interface or NULL, if creation of transition library failed.

A pointer to IUIAnimationTransitionFactory or NULL, if creation of transition factory failed. If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls on CAnimationController::IsValid return FALSE.

Provides access to encapsulated IUIAnimationTimer object.

A pointer to IUIAnimationTimer interface or NULL, if creation of animation timer failed. If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls on CAnimationController::IsValid return FALSE.

Provides access to encapsulated IUIAnimationTransitionLibrary object.

A pointer to IUIAnimationTransitionLibrary interface or NULL, if creation of transition library failed. If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls on CAnimationController::IsValid return FALSE.

Provides access to encapsulated IUIAnimationManager object.

A pointer to IUIAnimationManager interface or NULL, if creation of animation manager failed. If current OS does not support Windows Animation API, this method returns NULL and after that all subsequent calls on CAnimationController::IsValid return FALSE. You may need to access IUIAnimationManager in order to call its interface methods, which are not wrapped by animation controller.

The destructor. Called when animation controller object is being destroyed.

Constructs an animation controller.

A keyframe that represents start of storyboard.

A list of animation groups that belong to this animation controller.

A pointer to a related CWnd object, which can be automatically redrawn when the status of animation manager has changed, or post update event has occurred. Can be NULL.

Stores a pointer to Transition Factory COM object.

Stores a pointer to Animation Timer COM object.

Stores a pointer to Transition Library COM object.

Stores a pointer to Animation Manager COM object.

Specifies whether an animation controller is valid or not. This member is set to FALSE if current OS does not support Windows Animation API.

Implements the animation controller, which provides a central interface for creating and managing UI animations.

The CAnimationController class is the key class that manages animations. You may create one or more instances of animation controller in an application and, optionally, connect an instance of animation controller to a CWnd object using CAnimationController::SetRelatedWnd. This connection is required to send WM_PAINT messages to the related window automatically when animation manager status has changed or animation timer has been updated. If you do not enable this relation, you must redraw a window that displays an animation manually. For this purpose you can derive a class from CAnimationController and override OnAnimationManagerStatusChanged and/or OnAnimationTimerPostUpdate and invalidate one or more windows when necessary.

Specifies how to destroy animation objects. If this parameter is TRUE, animation objects will be destroyed automatically when the group is destroyed. Otherwise animation objects must be destroyed manually. The default value is FALSE. Set this value to TRUE only if all animation objects that belong to group are allocated dynamically with operator new.

Specifies how to clear transitions from animation objects that belong to group. If this member is TRUE, transitions are removed automatically when an animation has been scheduled. Otherwise you need to remove transitions manually.

Specifies how to destroy keyframes. If this value is TRUE, all keyframes are removed and destroyed; otherwise they are removed from the list only. The default value is TRUE.

Points to animation storyboard. This pointer is valid only after call on Animate.

Contains a list of keyframes.

Contains a list of animation objects.

Directs all animation objects that belong to group automatically destroy transitions.

Set this value to FALSE only if you allocate transitions on the stack. The default value is TRUE, therefore it's highly recommended to allocate transition objects using operator new. Specifies how to destroy transitions.

Schedules an animation at the specified time.

TRUE if the method succeeds; FALSE if the method fails or if Animate has not been called with bScheduleNow set to FALSE. Call this function to schedule an animation at the specified time. You must call Animate with bScheduleNow set to FALSE first. A pointer to animation timer. Specifies time to schedule the animation.

Animates a group.

TRUE if the method succeeds; otherwise FALSE. This method creates an internal storyboard, creates and applies transitions and schedules an animation if bScheduleNow is TRUE. If bScheduleNow is FALSE, you need to call Schedule to start animation at the specified time.

Finds an animation object that contains the specified animation variable.

A pointer to animation object, or NULL if animation object is not found. A pointer to animation variable.

Removes and optionally destroys all keyframes that belong to an animation group.

If m_bAutodestroyKeyframes member is TRUE then keyframes are removed and destroyed, otherwise keyframes are just removed from the internal list of keyframes.

Removes transitions from animation objects that belong to an animation group.

If m_bAutoclearTransitions flag is set to TRUE, this method loops over all animation objects that belong to the group and calls CAnimationObject::ClearTransitions(FALSE).

Applies transitions to animation objects.

This method ASSERTS in debug mode if storyboard has not been created. It creates all transitions first, then adds "static" keyframes (keyframes that depend on offsets), adds transitions that do not depend on keyframes, adds keyframes depending on transitions and other keyframes, and at last adds transitions that depend on keyframes.

Returns GroupID.

A group identifier.

The destructor. Called when an animation group is being destroyed.

Constructs an animation group.

A pointer to animation controller that creates a group. Specifies GroupID.

A helper that creates COM transition objects.

TRUE is the method succeeds, otherwise FALSE.

A helper that adds transitions to a storyboard.

A pointer to a storyboard COM object. Specifies whether this method should add to the storyboard transitions that depend on other keyframes.

A helper that adds keyframes to a storyboard.

A pointer to a storyboard COM object. Specifies whether this method should add to the storyboard keyframes that depend on other keyframes.

A pointer to animation controller this group belongs to.

A unique identifier of animation group.

Implements an animation group, which combines an animation storyboard, animation objects and transitions to define an animation.

Animation groups are created automatically by animation controller (CAnimationController) when you add animation objects using CAnimationController::AddAnimationObject. An animation group is identified by GroupID, which is usually taken as a parameter to manipulate animation groups. The GroupID is taken from the first animation object being added to a new animation group. An encapsulated animation storyboard is created after you call CAnimationController::AnimateGroup and can be accessed via public member m_pStoryboard.

Puts the encapsulated animation variables into a list.

When the function returns, it contains pointers to four CAnimationVariable objects representing coordinates of rectangle.

Specifies whether the rectangle has fixed size.

If this member is true, then the size of rectangle is fixed and right and bottom values are recalculated each time the top-left corner is moved according to the fixed size. Set this value to TRUE to easily move the rectangle around the screen. In this case transitions applied to right and bottom coordinates are ignored. The size is stored internally when you construct the object and/or call SetDefaultValue. By default this member is set to FALSE.

Adds transitions for left, top, right and bottom coordinates.

Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables for each rectangle sides. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. If you don't need to apply a transition to one of the rectangle sides, you can pass NULL. Specifies transition for the left side. Specifies transition for the top side. Specifies transition for the right side. Specifies transition for the bottom side.

Converts a CAnimationRect to RECT.

Current value of animation rectangle as RECT. This function internally calls GetValue. If GetValue for some reason fails, the returned RECT will contain default values for all rectangle coordinates.

Assigns rect to CAnimationRect.

It's recommended to do that before animation start, because this operator calls SetDefaultValue, which recreates the underlying COM objects for color components if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. The new value of animation rectangle.

Provides access to CAnimationVariable representing bottom coordinate.

A reference to encapsulated CAnimationVariable representing bottom coordinate. You can call this method to get direct access to underlying CAnimationVariable representing the bottom coordinate.

Provides access to CAnimationVariable representing right coordinate.

A reference to encapsulated CAnimationVariable representing right coordinate. You can call this method to get direct access to underlying CAnimationVariable representing the right coordinate.

Provides access to CAnimationVariable representing top coordinate.

A reference to encapsulated CAnimationVariable representing top coordinate. You can call this method to get direct access to underlying CAnimationVariable representing the top coordinate.

Provides access to CAnimationVariable representing left coordinate.

A reference to encapsulated CAnimationVariable representing left coordinate. You can call this method to get direct access to underlying CAnimationVariable representing the left coordinate.

Returns current value.

TRUE, if the current value was successfully retrieved; otherwise FALSE. Call this function to retrieve the current value of animation rectangle. If this method fails or underlying COM objects for left, top, right and bottom have not been initialized, rect contains default value, which was previously set in constructor or by SetDefaultValue. Output. Contains the current value when this method returns.

Returns the default values for rectangle's bounds.

A CRect value containing defaults for left, right, top and bottom. Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue.

Sets default value.

Use this function to set a default value to animation object. This methods assigns default values to rectangle's bounds. It also recreates underlying COM objects if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies new default values for left, top, right and bottom.

Constructs an animation rect object.

The object is constructed with specified coordinates of each side, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Specifies coordinate of left bound. Specifies coordinate of top bound. Specifies coordinate of right bound. Specifies coordinate of bottom bound. Specifies Group ID. Specifies Object ID. Specifies user-defined data.

Constructs an animation rect object.

The object is constructed with specified top-left corner coordinates and size of rectangle, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Coordinate of top-left corner. Size of rectangle. Specifies Group ID. Specifies Object ID. Specifies user-defined data.

Constructs an animation rect object.

The object is constructed with specified rect coordinates, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Specifies default rectangle. Specifies Group ID. Specifies Object ID. Specifies user-defined data.

Constructs a CAnimationRect object.

The object is constructed with default values for left, top, right and bottom, Object ID and Group ID, which will be set to 0. They can be changed later at runtime using SetDefaultValue and SetID.

Specifies initial size of animation rectangle.

The encapsulated animation variable that represents Bottom bound of animation rectangle.

The encapsulated animation variable that represents Right bound of animation rectangle.

The encapsulated animation variable that represents Top bound of animation rectangle.

The encapsulated animation variable that represents Left bound of animation rectangle.

Implements the functionality of a rectangle whose top, left, right and bottom sides can be animated.

The CAnimationRect class encapsulates four CAnimationVariable objects and can represent in applications a rectangle. To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to left, right top and bottom coordinates.

Puts the encapsulated animation variables into a list.

When the function returns, it contains pointers to three CAnimationVariable objects representing red, green and blue components.

Adds transitions for Red, Green and Blue components.

Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables representing color components. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. If you don't need to apply a transition to one of the color components, you can pass NULL. Transition for Red component. Transition for Green component. Transition for Blue component.

Converts a CAnimationColor to COLORREF.

Current value of animation color object as COLORREF. This function internally calls GetValue. If GetValue for some reason fails, the returned COLORREF will contain default values for all color components.

Assigns color to CAnimationColor.

Provides access to CAnimationVariable representing Blue component.

A reference to encapsulated CAnimationVariable representing Blue component. You can call this method to get direct access to underlying CAnimationVariable representing Blue component.

Provides access to CAnimationVariable representing Green component.

A reference to encapsulated CAnimationVariable representing Green component. You can call this method to get direct access to underlying CAnimationVariable representing Green component.

Provides access to CAnimationVariable representing Red component.

A reference to encapsulated CAnimationVariable representing Red component. You can call this method to get direct access to underlying CAnimationVariable representing Red component.

Returns current value.

TRUE, if the current value was successfully retrieved; otherwise FALSE. Call this function to retrieve the current value of animation color. If this method fails or underlying COM objects for color components have not been initialized, color contains default value, which was previously set in constructor or by SetDefaultValue. Output. Contains the current value when this method returns.

Returns the default values for color components.

A COLORREF value containing defaults for RGB components. Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue.

Sets default value.

Use this function to set a default value to animation object. This methods assigns default values to color components of animation color. It also recreates underlying COM objects if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies new default values for red, green and blue components.

Constructs an animation color object.

The object is constructed with specified values for RGB components, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Specifies default color. Specifies Group ID. Specifies Object ID. Specifies user-defined data.

Constructs a CAnimationColor object.

The object is constructed with default values for red, green, blue, Object ID and Group ID, which will be set to 0. They can be changed later at runtime using SetDefaultValue and SetID.

The encapsulated animation variable that represents Blue component of animation color.

The encapsulated animation variable that represents Green component of animation color.

The encapsulated animation variable that represents Red component of animation color.

Implements the functionality of a color whose red, green and blue components can be animated.

The CAnimationColor class encapsulates three CAnimationVariable objects and can represent in applications a color. For example, you can use this class to animate colors of any object on the screen (like text color, background color etc). To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to Red, Green and Blue components.

Puts the encapsulated animation variables into a list.

When the function returns, it contains pointers to two CAnimationVariable objects representing the width and height.

Adds transitions for Width and Height.

Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables for Width and Height. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. If you don't need to apply a transition to one of dimensions, you can pass NULL. A pointer to transition for Width. A pointer to transition for Height.

Converts a CAnimationSize to a CSize.

Current value of animation size as CSize. This function internally calls GetValue. If GetValue for some reason fails, the returned size will contain default values for Width and Height.

Assigns szSrc to CAnimationSize.

Assigns szSrc to CAnimationSize. It's recommended to do that before animation start, because this operator calls SetDefaultValue, which recreates the underlying COM objects for Width and Height if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Refers to CSize or SIZE.

Provides access to CAnimationVariable representing Height.

A reference to encapsulated CAnimationVariable representing Height. You can call this method to get direct access to underlying CAnimationVariable representing Height.

Provides access to CAnimationVariable representing Width.

A reference to encapsulated CAnimationVariable representing Width. You can call this method to get direct access to underlying CAnimationVariable representing Width.

Returns current value.

TRUE, if the current value was successfully retrieved; otherwise FALSE. Call this function to retrieve the current value of animation size. If this method fails or underlying COM objects for Width and Size have not been initialized, szValue contains default value, which was previously set in constructor or by SetDefaultValue. Output. Contains the current value when this method returns.

Returns the default values for Width and Height.

A CSize object containing default values. Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue.

Sets default value.

Use this function to set a default value to animation object. This methods assigns default values to Width and Height of animation size. It also recreates underlying COM objects if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies new default size.

Constructs an animation size object.

The object is constructed with specified values for width, height, Object ID and Group ID. They can be changed later at runtime using SetDefaultValue and SetID. Specifies default size. Specifies Group ID. Specifies Object ID. Specifies user-defined data.

Constructs an animation size object.

The object is constructed with default values for width, height, Object ID and Group ID, which will be set to 0. They can be changed later at runtime using SetDefaultValue and SetID.

The encapsulated animation variable that represents height of animation size.

The encapsulated animation variable that represents width of animation size.

Implements the functionality of a size object whose dimensions can be animated.

The CAnimationSize class encapsulates two CAnimationVariable objects and can represent in applications a size. For example, you can use this class to animate a size of any two dimensional object on the screen (like rectangle, control etc). To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to Width and/or Height.

Puts the encapsulated animation variables into a list.

When the function returns, it contains pointers to two CAnimationVariable objects representing the X and Y coordinates.

Adds transitions for X and Y coordinates.

Call this function to add the specified transitions to the internal list of transitions to be applied to animation variables for X and Y coordinates. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. If you don't need to apply a transition to one of coordinates, you can pass NULL. A pointer to transition for X coordinates. A pointer to transition for Y coordinate.

Provides access to CAnimationVariable for Y coordinate.

A reference to encapsulated CAnimationVariable representing Y coordinate. You can call this method to get direct access to underlying CAnimationVariable representing Y coordinate.

Provides access to CAnimationVariable for X coordinate.

A reference to encapsulated CAnimationVariable representing X coordinate. You can call this method to get direct access to underlying CAnimationVariable representing X coordinate.

Converts a CAnimationPoint to a CPoint.

Current value of CAnimationPoint as CPoint. This function internally calls GetValue. If GetValue for some reason fails, the returned point will contain default values for X and Y coordinates.

Assigns ptSrc to CAnimationPoint.

Assigns ptSrc to CAnimationPoint. It's recommended to do that before animation start, because this operator calls SetDefaultValue, which recreates the underlying COM objects for X and Y coordinates if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Refers to CPoint or POINT.

Returns current value.

TRUE, if the current value was successfully retrieved; otherwise FALSE. Call this function to retrieve the current value of animation point. If this method fails or underlying COM objects for X and Y coordinates have not been initialized, ptValue contains default value, which was previously set in constructor or by SetDefaultValue. Output. Contains the current value when this method returns.

Returns the default values for X and Y coordinates.

A point containing default value. Call this function to retrieve default value, which was previously set by constructor or SetDefaultValue.

Sets default value.

Use this function to set a default value to animation object. This methods assigns default values to X and Y coordinates of animation point. It also recreates underlying COM objects if they have been created. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies the default point value.

Constructs CAnimationPoint object.

Constructs CAnimationPoint object with specified properties. Specifies default point coordinates. Specifies Group ID. Specifies Object ID. Specifies user-defined data.

Constructs CAnimationPoint object.

Constructs CAnimationPoint object with default properties: default point coordinates, Group ID and Object ID are set to 0.

The encapsulated animation variable that represents Y coordinate of animation point.

The encapsulated animation variable that represents X coordinate of animation point.

Implements the functionality of a point whose coordinates can be animated.

The CAnimationPoint class encapsulates two CAnimationVariable objects and can represent in applications a point. For example, you can use this class to animate a position of any object on the screen (like text string, circle, point etc). To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to X and/or Y coordinates.

Puts the encapsulated animation variable into a list.

When the function returns, it contains a pointer to CAnimationVariable representing the animated value.

Adds a transition to be applied to a value.

Call this function to add a transition to internal list of transitions to be applied to an animation variable. When you add transitions, they are not applied immediately and stored in an internal list. Transitions are applied (added to a storyboard for a particular value) when you call CAnimationController::AnimateGroup. A pointer to transition object.

Provides access to encapsulated animation variable.

A reference to encapsulated animation variable. Use this method to access the encapsulated animation variable. From CAnimationVariable you get access to underlying IUIAnimationVariable object, whose pointer can be NULL if animation variable has not been created.

Assigns an INT32 value to CAnimationValue.

Assigns an INT32 value to CAnimationValue. This value is set as a default value for encapsulated animation variable. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies the value to be assigned to Animation Value.

Assigns a DOUBLE value to CAnimationValue.

Assigns a DOUBLE value to CAnimationValue. This value is set as a default value for encapsulated animation variable. If you subscribed this animation object to events (ValueChanged or IntegerValueChanged), you need to re-enable these events. Specifies the value to be assigned to Animation Value.

Provides conversion between CAnimationValue and INT32.

Current value of Animation Value as integer. Provides conversion between CAnimationValue and INT32. This method internally calls GetValue and doesn't check for errors. If GetValue fails, the returned value will contain a default value previously set in constructor or with SetDefaultValue.

Provides conversion between CAnimationValue and DOUBLE.

Current value of Animation Value. Provides conversion between CAnimationValue and DOUBLE. This method internally calls GetValue and doesn't check for errors. If GetValue fails, the returned value will contain a default value previously set in constructor or with SetDefaultValue.

Retrieves the current value.

TRUE if the current value was retrieved successfully; otherwise FALSE. Call this function to retrieve the current value. This implementation calls the encapsulated COM object, and if the call fails, this method returns the default value that was previously set in constructor or with SetDefaultValue. Output. When the function returns it contains a current value of animation variable.

Retrieves the current value.

Sets default value.

Use this method to set a default value. A default value is returned to application when animation has not been started and/or underlying COM object has not been created. If the underlying COM object encapsulated in CAnimationVarible was already created, this method recreates it, therefore you might need to call EnableValueChanged/EnableIntegerValueChanged methods again. Specifies the default value.

Constructs a CAnimationValue object.

Constructs CAnimationValue object with specified properties. Specifies default value. Specifies Group ID. Specifies Object ID. specifies user-defined data.

Constructs a CAnimationValue object.

Constructs CAnimationValue object with default properties: default value, Group ID and Object ID are set to 0.

The encapsulated animation variable that represents animation value.

Implements the functionality of animation object with one value.

The CAnimationValue class encapsulates a single CAnimationVariable object and can represent in applications a single animated value. For example, you can use this class for animated transparency (fade effect), angle (to rotate objects), or for any other case when you need to create an animation depending on a single animated value. To use this class in application, just instantiate an object of this class, add it to animation controller using CAnimationController::AddAnimationObject and call AddTransition for each transition to be applied to the value.

Establishes relationship between animation variables, contained in an animation object, and their container.

This is a helper that can be used to establish relationship between animation variables, contained in an animation object, and their container. It loops over animation variables and sets a back pointer to a parent animation object to each animation variable. In the current implementation the actual relationship is established in CAnimationBaseObject::ApplyTransitions, therefore back pointers are not set until you call CAnimationGroup::Animate. Knowing the relationship may be helpful when you processing events and need to get a parent animation object from CAnimationVariable (use CAnimationVariable::GetParentAnimationObject).

Collects pointers to contained animation variables.

This is a pure virtual method that must be overridden in a derived class. An animation object, depending on its type, contains one or more animation variables. For example, CAnimationPoint contains two variables, for X and Y coordinates respectively. The base class CAnimationBaseObject implements some generic methods, which act on a list of animation variables: ApplyTransitions, ClearTransitions, EnableValueChangedEvent, EnableIntegerValueChangedEvent. These methods call GetAnimationVariableList, which is filled in a derived class with actual animation variables contained in a particular animation object, then loop over the list and perform necessary actions. If you create a custom animation object, you must add to lst all animation variables contained in that object. A list that must be filled with animation variables contained in an animation object.

Determines whether an animation object contains a particular animation variable.

TRUE if the animation variable is contained in the animation object; otherwise FALSE. This method can be used to determine whether an animation variable specified by pVariable is contained within an animation object. An animation object, depending on its type, may contain several animation variables. For example, CAnimationColor contains three variables, one for each color component (red, green and blue). When a value of animation variable has changed, Windows Animation API sends ValueChanged or IntegerValueChanged events (if enabled), and the parameter of this event is a pointer to interface IUIAnimationVariable of animation variable. This method helps to obtain a pointer to animation from a pointer to contained COM object. A pointer to animation variable.

Sets up Integer Value Changed event handler.

If the Integer Value Changed event handler is enabled, you can handle this event in CAnimationController::OnAnimationIntegerValueChanged method, which should be overridden in a CAnimationController-derived class. This method is called every time the animation integer value has changed. A pointer to a parent controller. Specifies whether to enable, or disable Integer Value Changed event.

Sets up Value Changed event handler.

If the Value Changed event handler is enabled, you can handle this event in CAnimationController::OnAnimationValueChanged method, which should be overridden in a CAnimationController-derived class. This method is called every time the animation value has changed. A pointer to a parent controller. Specifies whether to enable, or disable Value Changed event.

Removes all related transitions.

Removes all related transitions and destroys them if bAutodestroy or m_bAutodestroyTransitions flag is TRUE. Transitions should be destroyed automatically only if they are not allocated on the stack. If the above flags are FALSE, transitions are just removed from the internal list of related transitions. Specifies whether to destroy transition objects automatically, or just remove them from the related list.

Adds transitions to storyboard with encapsulated animation variable.

TRUE if transitions were added successfully. Adds related transitions, that have been added with AddTransition (overloaded methods in derived classes), to storyboard. A pointer to a storyboard. With FALSE this method adds only those transitions that do not depend on keyframes.

Tells whether related transition are destroyed automatically.

If TRUE, related transitions are destroyed automatically; if FALSE, transition objects should be deallocated by calling application. By default this flag is TRUE. Set this flag only if you allocated transition on the stack and/or transitions should be deallocated by the calling application.

Sets a flag that orders to automatically destroy transitions.

Set this flag only if you allocated transition objects using operator new. If for some reason transition objects are allocated on the stack, the auto destroy flag should be FALSE. By default this flag is TRUE. Specifies the auto destroy flag.

Returns user defined data.

A value of custom data. Call this method to retrieve the custom data at runtime. The returned value will be 0 if it was not explicitly initialized in constructor or with SetUserData.

Returns current Group ID.

Current Group ID. Use this method to retrieve Group ID. It's 0 if Group ID has not been set explicitly in constructor or with SetID.

Returns current Object ID.

Current Object ID. Use this method to retrieve Object ID. It's 0 if Object ID has not been set explicitly in constructor or with SetID.

Detaches an animation object from parent animation controller.

This method is used internally.

Sets user-defined data.

Use this method to associate a custom data with an animation object. This data may be retrieved later at runtime by GetUserData. Specifies the custom data.

Sets new IDs.

Allows to change Object ID and Group ID. If the new Group ID differs from the current ID, an animation object is moved to another group (a new group will be created, if necessary). Specifies new Object ID. Specifies new Group ID.

Creates transitions associated with an animation object.

TRUE if transitions were created successfully; otherwise FALSE. Loops over list of animation variables encapsulated in a derived animation object and creates transitions associated with each animation variable.

The destructor. Called when an animation object is being destroyed.

Constructs an animation object.

Constructs an animation object with specified Object ID and Group ID. Specifies Group ID. Specifies Object ID. User-defined data, which can be associated with animation object and retrieved later at runtime.

Constructs an animation object.

Constructs an animation objects and assigns default Object ID (0) and Group ID (0).

A pointer to the parent animation controller.

Specifies whether related transitions should be automatically destroyed.

Stores user-defined data.

Specifes the Object ID of the animation object.

Specifies the Group ID of the animation object.

The base class for all animation objects.

This class implements basic methods for all animation objects. An animation object can represent a value, point, size, rectangle or color in an application, as well as any custom entity. Animation objects are stored in animation groups (see CAnimationGroup). Each group can be animated separately and can be treated as an analogue of storyboard. An animation object encapsulates one or more animation variables (see CAnimationVariable), depending on its logical representation. For example, CAnimationRect contains four animation variables - one variable for each side of rectangle. Each animation object class exposes overloaded AddTransition method, which should be used to apply transitions to encapsulated animation variables. An animation object can be identified by Object ID (optionally) and by Group ID. A Group ID is necessary in order to place an animation object to correct group, but if a Group ID is not specified, an object is placed in the default group with ID 0. If you call SetID with different GroupID, an animation object will be moved to another group (a new group is created if necessary).

Specifies whether related transition objects should be deleted.

Set this value to TRUE to force deletion of transition objects when they are being removed from the internal list of transitions. If this value is FALSE the transitions should be deleted by calling application. The list of transitions is always cleared after an animation has been scheduled. The default value is FALSE.

Returns default value.

The default value. Use this function to obtain default value of animation variable. The default value can be set in constructor or by SetDefaultValue method.

Enables or disables the IntegerValueChanged event.

When ValueChanged event is enabled, the framework calls virtual method CAnimationController::OnAnimationIntegerValueChanged. You need to override it in a class derived from CAnimationController in order to process this event. This method is called every time the integer value of animation variable is changed. A pointer to parent controller. TRUE - enable event, FALSE - disable event.

Enables or disables the ValueChanged event.

When ValueChanged event is enabled, the framework calls virtual method CAnimationController::OnAnimationValueChanged. You need to override it in a class derived from CAnimationController in order to process this event. This method is called every time the value of animation variable is changed. A pointer to parent controller. TRUE - enable event, FALSE - disable event.

Adds transitions from the internal list to storyboard.

This method adds transitions from the internal list to storyboard. It's called from the top level code several times to add transitions that do not depend on keyframes and add transitions that depend on keyframes. If the underlying animation variable COM object has not been created, this method creates it at this stage. A pointer to parent animation controller. A pointer to storyboard. TRUE, if this method should add transitions that depend on keyframes.

Clears transitions.

This method removes all transitions from the internal list of transitions. If bAutodestroy is TRUE, or m_bAutodestroyTransitions is TRUE, then transitions are deleted. Otherwise the caller should deallocate the transition objects. Specifies whether this method should delete transition objects.

Adds a transition.

This method is called to add a transition to the internal list of transitions to be applied to the animation variable. This list should be cleared when an animation has been scheduled. A pointer to a transition to add.

Returns the current value of animation variable.

S_OK if the value was obtained successfully, or underlying animation variable has not been created. Otherwise HRESULT error code. This method can be called to retrieve the current value of animation variable. If the underlying COM object has not been created, dblValue will contain a default value, when the function returns. The current value of the animation variable.

Returns the current value of animation variable.

Creates all transitions to be applied to this animation variable.

TRUE if transitions were created successfully; otherwise FALSE. This method is called by the framework when it needs to create transitions that have been added to the variable's internal list of transitions. A pointer to transition library. A pointer to transition factory.

Creates the underlying animation variable COM object.

TRUE if the animation variable was successfully created; otherwise FALSE. This method creates the underlying animation variable COM object and sets its default value. A pointer to animation manager.

Sets default value and releases IUIAnimationVariable COM object.

Use this method to reset the default value. This method releases the internal IUIAnimationVariable COM object, therefore when animation variable is recreated, the underlying COM object gets the new default value. The default value is returned by GetValue if the COM object representing the animation variable is not created, or if the variable has not been animated. Specifies the new default value.

Returns a pointer to IUIAnimationVariable COM object.

A valid pointer to IUIAnimationVariable COM object, or NULL if animation variable was not created, or can't be created. Use this function to access the underlying IUIAnimationVariable COM object and call its methods directly if needed.

Returns the parent animation object.

A pointer to parent animation object, if relationship was established, otherwise NULL. This method can be called to retrieve a pointer to a parent animation object (a container).

The destructor. Called when a CAnimationVariable object is being destroyed.

Constructs an animation variable object.

Constructs an animation variable object and sets its default value. A default value is used when a variable is not animated, or can't be animated. Specifies the default value.

Sets the relationship between an animation variable and an animation object.

This method is called internally to establish one-to-one relationship between an animation variable and an animation object that encapsulates it. A pointer to an animation object that contains this variable.

A pointer to an animation object that encapsulates this animation variable.

Contains a list of transitions that animate this animation variable.

Specifies the default value, which is propagated to IUIAnimationVariable.

Stores a pointer to IUIAnimationVariable COM object. NULL if the COM object has not been created yet, or if creation failed.

Represents an animation variable.

The CAnimationVariable class encapsulates IUIAnimationVariable COM object. It also holds a list of transitions to be applied to the animation variable in a storyboard. CAnimationVariable objects are embedded to animation objects, which can represent in an application an animated value, point, size, color and rectangle.

Adds a keyframe to storyboard at offset.

TRUE, if keyframe was added successfully. This function is called by the framework to add a keyframe to storyboard at offset. A pointer to a storyboard. Specifies whether to add a keyframe this keyframe depend on recursively.

Adds a keyframe to storyboard after transition.

TRUE, if keyframe was added successfully. This function is called by the framework to add a keyframe to storyboard after transition. A pointer to a storyboard. Specifies whether to add a transition recursively.

Adds a keyframe to a storyboard.

TRUE, if keyframe was added successfully. This method adds a keyframe to storyboard. If it depends on other keyframe or transition and bDeepAdd is TRUE, this method tries to add them recursively. A pointer to a storyboard. Specifies whether to add keyframe or transition recursively.

Returns an offset from other keyframe.

An offset in seconds from other keyframe. This method should be called to determine an offset in seconds from other keyframe.

Returns a pointer to a keyframe this keyframe depends on.

A valid pointer to keyframe, or NULL if this keyframe does not depend on other keyframe. This is an accessor to a keyframe this keyframe depends on.

Returns a pointer to a transition this keyframe depends on.

A valid pointer to transition, or NULL if this keyframe does not depend on transition. This is an accessor to a transition this keyframe depends on.

Constructs a keyframe that depends on other keyframe.

The constructed keyframe will represent a moment in time within a storyboard, which has a specified offset from pKeyframe. A pointer to keyframe. Offset, in seconds, from keyframe specified by pKeyframe.

Constructs a keyframe that depends on a transition.

The constructed keyframe will represent a moment in time within a storyboard when the specified transition ends. A pointer to a transition.

Stores a pointer to an existing keframe. This keyframe is added to storyboard with m_offset to the existing keyframe.

Specifies offset of this keyframe from a keyframe stored in m_pExistingKeyFrame.

Stores a pointer to transtion that begins at this keyframe.

Represents an animation keyframe.

This class implements an animation keyframe. A keyframe represents a moment in time within a storyboard and can be used to specify the start and end times of transitions. A keyframe may be based on other keyframe and have an offset (in seconds) from it, or may be based on a transition and represent a moment in time when this transition ends.

Adds a keyframe to storyboard.

TRUE if keyframe was added to storyboard successfully; otherwise FALSE. This method is called to add a keyframe to storyboard. A pointer to a storyboard. If this parameter is TRUE and the keyframe being added depends on some other keyframe or transition, this method tries to add this keyframe or transition to storyboard first.

Specifies whether the keyframe should be added to storyboard at offset, or after transition.

TRUE if the keyframe should be added to storyboard at some specified offset. FALSE if the keyframe should be added to storyboard after some transition. Specifies whether the keyframe should be added to storyboard at offset. The offset or transition must be specified in a derived class.

Tells whether a keyframe has been added to storyboard.

TRUE if a keyframe is added to a storyboard; otehrwise FALSE. In the base class IsAdded always returns TRUE, but it's overridden in derived classes.

Returns the underlying keyframe value.

A current keyframe. The default value is UI_ANIMATION_KEYFRAME_STORYBOARD_START. This is an accessor to the underlying keyframe value.

Constructs a keyframe object.

Specifies whether this keyframe should be added to storyboard at an offset from another existing keyframe, or at the end of some transition.

Specifies whether this keyframe has been added to a storyboard.

Represents a Windows Animation API keyframe. When a keyframe is not initialized it is set to the predefined value UI_ANIMATION_KEYFRAME_STORYBOARD_START.

Implements basic functionality of keyframe.

Encapsulates UI_ANIMATION_KEYFRAME variable. Serves as a base class for any keyframe implementation. A keyframe represents a moment in time within a storyboard and can be used to specify the start and end times of transitions. There are two types of keyframes - keyframes added to storyboard at the specified offset (in time), or keyframes added after specified transition. Because durations of some transitions can't be known before animation starts, the actual values of some keyframes are determined at runtime only. Because keyframes may depend on transitions, which in their turn depend on keyframes, it's important to prevent infinite recursions when building keyframe chains.

Specifies whether a transition has been added to a storyboard.

A pointer to an animation variable, which is animated with the transition stored in m_transition.

Stores a pointer to the keyframe that specifies the end of the transition.

Stores a pointer to the keyframe that specifies the beginning of the transition.

Stores a pointer to IUIAnimationTransition. NULL if a COM transition object has not been created.

Stores the transition type.

Adds a transition to a storyboard.

TRUE, if transition was successfully added to a storyboard. Applies the transition to the related variable in the storyboard. If the start keyframe was specified, the transition begins at that keyframe. If the end keyframe was specified, the transition begins at the start keyframe and and stops at the end keyframe. If the transition was created with a duration parameter specified, that duration is overwritten with the duration of time between the start and end keyframes. If no keyframe was specified, the transition is appended to the transition added most recently to the variable. A pointer to storyboard, which will animate the related variable.

Adds a transition to a storyboard.

TRUE, if transition was successfully added to a storyboard. Applies the transition to the related variable in the storyboard. If this is the first transition applied to this variable in this storyboard, the transition begins at the start of the storyboard. Otherwise, the transition is appended to the transition added most recently to the variable. A pointer to storyboard, which will animate the related variable.

Returns a pointer to related variable.

A valid pointer to animation variable, or NULL if an animation variable has not been set by SetRelatedVariable. This is an accessor to related animation variable.

Establishes a relationship between animation variable and transition.

Establishes a relationship between animation variable and transition. A transition can be applied only to one variable. A pointer to related animation variable.

Returns start keyframe.

A valid pointer to a keyframe, or NULL if a transition should not be inserted between keyframes. This method can be used to access a keyframe object that was previously set by SetKeyframes. It's called by top level code when transitions are being added to storyboard.

Returns start keyframe.

A valid pointer to a keyframe, or NULL if a transition should not start after a keyframe. This method can be used to access a keyframe object that was previously set by SetKeyframes. It's called by top level code when transitions are being added to storyboard.

Tells whether a transition has been added to a storyboard.

Returns TRUE if a transition has been added to a storyboard, otherwise FALSE. This flag is set internally when the top level code adds transitions to storyboard.

Sets keyframes for a transition.

This method tells the transition to start after specified keyframe and, optionally, if pEnd is not NULL, end before the specified keyframe. If the transition was created with a duration parameter specified, that duration is overwritten with the duration of time between the start and end keyframes. A keyframe that specifies the beginning of the transition. A keyframe that specifies the end of the transition.

Returns a pointer to underlying COM transition object.

A valid pointer to IUIAnimationTransition or NULL if underlying transition can't be created. It's an accessor method to underlying COM transition object. It doesn't instantiates the underlying IUIAnimationTransition COM object if it wasn't created.

Returns a pointer to underlying COM transition object.

A valid pointer to IUIAnimationTransition or NULL if underlying transition can't be created. This method returns a pointer to underlying COM transition object and creates it if necessary. A pointer to transition library, which creates standard transitions. It can be NULL for custom transitions. A pointer to transition factory, which creates custom transitions. It can be NULL for standard transitions.

Creates a COM transition.

TRUE if a transition COM object was created successfully; otherwise FALSE. This is a pure virtual function that must be overridden in a derived class. It's called by the framework to instantiate the underlying COM transition object. A pointer to transition library, which creates standard transitions. It can be NULL for custom transitions. A pointer to transition factory, which creates custom transitions. It can be NULL for standard transitions.

Returns transition type.

One of TRANSITION_TYPE enumerated values. This method can be used to identify a transition object by its type. The type is set in a constructor in a derived class.

Releases encapsulated IUIAnimationTransition COM object.

This method should be called from a derived class's Create method in order to prevent IUITransition interface leak.

The destructor. Called when a transition object is being destroyed.

Constructs a base transtion object.

Defines the transition types currently supported by the MFC implementation of Windows Animation API.

A transition type is set in the constructor of specific transition. For example, CSinusoidalTransitionFromRange sets its type to SINUSOIDAL_FROM_RANGE.

Represents a basic transition.

This class encapsulates IUIAnimationTransition interface and serves as a base class for all transitions.