AISmoothShadingStyleSuite Struct Reference
[API Suite List]

This suite provides you functions which allow you to interact with the smooth style. More...

#include <AISmoothShadingStyle.h>

List of all members.

Public Attributes
AIAPI AIBoolean(*	IsFocusSmoothShading )(AIArtStyleHandle inArtStyle)
	Returns true if focus fill is SmoothShading else returns false.
AIAPI void(*	ArtHasFocusSmoothShading )(AIArtHandle inArt, AIBoolean &containsSmoothShading, AIBoolean &isVisible)
	Determines if inArt has SmoothShading in focus Direct use of this api is more optimal than fetching the art style of art and then calling IsFocusSmoothShading.
AIAPI AIBoolean(*	CompareFocusSmoothFill )(AIArtStyleHandle inArtStyle1, AIArtStyleHandle inArtStyle2)
	Returns true if focal fill in inArtStyle1 and focal fill in inArtStyle2 are same.
AIAPI AIBoolean(*	Compare )(const AISmoothShadingStyle &inSmoothShading1, const AISmoothShadingStyle &inSmoothShading2)
	Returns true if both smooth shadings are same.
AIAPI AIBoolean(*	ContainsSmoothShading )(AIArtStyleHandle inArtStyle)
	Returns true if inArtStyle contains at least one SmoothShading field.
AIAPI AIBoolean(*	ArtContainsSmoothShading )(AIArtHandle inArt)
	Returns true if style of inArt contains at least one SmoothShading field.
AIAPI AIBoolean(*	GetFocusSmoothShadingStyle )(AIArtStyleHandle artStyle, AISmoothShadingStyle &outSmoothStyle)
	Retrieves focus SmoothShadingStyle information if art style has focus fill as smooth shading else returns false.

---

Detailed Description

This suite provides you functions which allow you to interact with the smooth style.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAISmoothShadingStyleSuite and kAISmoothShadingStyleVersion.

---

Member Data Documentation

AIAPI AIBoolean(* AISmoothShadingStyleSuite::ArtContainsSmoothShading)(AIArtHandle inArt)

Returns true if style of inArt contains at least one SmoothShading field.

Parameters:

inArt,:

art to search for. If you want to check for an art, it more optimal to call this api rather than first getting the style and then calling ContainsSmoothShading over it.

AIAPI void(* AISmoothShadingStyleSuite::ArtHasFocusSmoothShading)(AIArtHandle inArt, AIBoolean &containsSmoothShading, AIBoolean &isVisible)

Determines if inArt has SmoothShading in focus Direct use of this api is more optimal than fetching the art style of art and then calling IsFocusSmoothShading.

Parameters:

	inArtStyle,:	Input artsyle.
	containsSmoothShading,:	is set to true if inArt has smoothshading in focus
	isVisible,:	is set to true if inArt has smoothshading and is visible

AIAPI AIBoolean(* AISmoothShadingStyleSuite::Compare)(const AISmoothShadingStyle &inSmoothShading1, const AISmoothShadingStyle &inSmoothShading2)

Returns true if both smooth shadings are same.

Parameters:

	inArtStyle1,:	Input smooth shading style 1.
	inArtStyle2,:	Input smooth shading style 2.

AIAPI AIBoolean(* AISmoothShadingStyleSuite::CompareFocusSmoothFill)(AIArtStyleHandle inArtStyle1, AIArtStyleHandle inArtStyle2)

Returns true if focal fill in inArtStyle1 and focal fill in inArtStyle2 are same.

Parameters:

	inArtStyle1,:	Input art style 1.
	inArtStyle2,:	Input art style 2.

AIAPI AIBoolean(* AISmoothShadingStyleSuite::ContainsSmoothShading)(AIArtStyleHandle inArtStyle)

Returns true if inArtStyle contains at least one SmoothShading field.

Parameters:

inArtStyle1,:

ArtStyle to search for.

AIAPI AIBoolean(* AISmoothShadingStyleSuite::GetFocusSmoothShadingStyle)(AIArtStyleHandle artStyle, AISmoothShadingStyle &outSmoothStyle)

Retrieves focus SmoothShadingStyle information if art style has focus fill as smooth shading else returns false.

Parameters:

	artStyle	The art style.
	outSmoothStyle	[out] A buffer in which to return the SmoothShadingStyle style.

AIAPI AIBoolean(* AISmoothShadingStyleSuite::IsFocusSmoothShading)(AIArtStyleHandle inArtStyle)

Returns true if focus fill is SmoothShading else returns false.

Parameters:

inArtStyle,:

Input artsyle.

---

The documentation for this struct was generated from the following file:

• AISmoothShadingStyle.h