Aspose::Slides::Effects::HSL Class Reference

Represents a Hue/Saturation/Luminance effect. The hue, saturation, and luminance may each be adjusted relative to its current value. More...

Inherits Aspose::Slides::Effects::ImageTransformOperation, Aspose::Slides::Effects::IHSL, and Aspose::Slides::Effects::IVisualEffect.

Public Member Functions

System::SharedPtr< EffectEffectiveDataGetEffective ()
 
virtual bool Equals (System::SharedPtr< System::Object > obj)
 Determines whether the specified HSL is equal to the current HSL. More...
 
virtual int32_t GetHashCode () const
 Serves as a hash function for a particular type. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

float get_Hue ()
 
void set_Hue (float value)
 
float get_Saturation ()
 
void set_Saturation (float value)
 
float get_Luminance ()
 
void set_Luminance (float value)
 
 HSL (float hue, float saturation, float luminance, System::SharedPtr< IDOMObject > parentImmediate)
 Hue/Saturation/Luminance effect constructor. More...
 
System::SharedPtr< HSLEffectiveDataGetEffective_ ()
 
virtual System::SharedPtr< TrueColorBitmap > Apply (System::SharedPtr< TrueColorBitmap > img, System::SharedPtr< IBaseSlide > slide, System::SharedPtr< FloatColor > styleColor)
 
virtual System::String GetStringData (System::SharedPtr< IBaseSlide > slide, System::SharedPtr< FloatColor > styleColor)
 
virtual System::SharedPtr< ImageTransformOperationClone ()
 Returns effect object with new parent. In most cases returns the same object, but some can create a copy. More...
 
virtual ~HSL ()
 
- Protected Member Functions inherited from Aspose::Slides::Effects::ImageTransformOperation
System::SharedPtr< ImageTransformOperationget_RealObject ()
 
virtual uint32_t get_Version ()
 Version. Read-only uint32_t. More...
 
 ImageTransformOperation (System::SharedPtr< IDOMObject > parentImmediate)
 
virtual void CreateChildObjects ()
 
virtual System::SharedPtr< System::ObjectCreateRealObject ()
 
virtual void SetParent (System::SharedPtr< IDOMObject > parentImmediate)
 
void Changed ()
 
void OnImageTransformOperationChanged ()
 
virtual ~ImageTransformOperation ()
 
- Protected Member Functions inherited from Aspose::Slides::PVIObject
System::SharedPtr< ObjectWrapper > get_Wrapper () const
 
System::SharedPtr< IDOMObjectget_Parent_Immediate ()
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
void set_Parent_Immediate (System::SharedPtr< IDOMObject > value)
 
System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()
 Returns parent IPresentationComponent. Read-only IPresentationComponent. More...
 
System::SharedPtr< ISlideComponentget_Parent_ISlideComponent ()
 
System::SharedPtr< BaseSlideget_Slide ()
 
System::SharedPtr< Aspose::Slides::Presentationget_Presentation ()
 
 PVIObject (System::SharedPtr< IDOMObject > parentImmediate)
 
void Reset_Parent_IPresentationComponent ()
 
virtual ~PVIObject ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
- Protected Attributes inherited from Aspose::Slides::Effects::ImageTransformOperation
System::Event< void()> ImageTransformOperationChanged
 

Detailed Description

Represents a Hue/Saturation/Luminance effect. The hue, saturation, and luminance may each be adjusted relative to its current value.

Constructor & Destructor Documentation

◆ HSL()

Aspose::Slides::Effects::HSL::HSL ( float  hue,
float  saturation,
float  luminance,
System::SharedPtr< IDOMObject parentImmediate 
)
protected

Hue/Saturation/Luminance effect constructor.

Parameters
hueThe number of degrees by which the hue is adjusted.
saturationThe percentage by which the saturation is adjusted.
luminanceThe percentage by which the luminance is adjusted.
parentImmediateThe parent collection for HSL.

◆ ~HSL()

virtual Aspose::Slides::Effects::HSL::~HSL ( )
protectedvirtual

Member Function Documentation

◆ Apply()

virtual System::SharedPtr<TrueColorBitmap> Aspose::Slides::Effects::HSL::Apply ( System::SharedPtr< TrueColorBitmap >  img,
System::SharedPtr< IBaseSlide slide,
System::SharedPtr< FloatColor >  styleColor 
)
protectedvirtual

◆ Clone()

virtual System::SharedPtr<ImageTransformOperation> Aspose::Slides::Effects::HSL::Clone ( )
protectedvirtual

Returns effect object with new parent. In most cases returns the same object, but some can create a copy.

Returns

Implements Aspose::Slides::Effects::ImageTransformOperation.

◆ Equals()

virtual bool Aspose::Slides::Effects::HSL::Equals ( System::SharedPtr< System::Object obj)
virtual

Determines whether the specified HSL is equal to the current HSL.

Parameters
objThe HSL to compare.
Returns
true if objects are equal; otherwise, false.

Reimplemented from Aspose::Slides::PVIObject.

◆ get_Hue()

float Aspose::Slides::Effects::HSL::get_Hue ( )
protected

◆ get_Luminance()

float Aspose::Slides::Effects::HSL::get_Luminance ( )
protected

◆ get_Saturation()

float Aspose::Slides::Effects::HSL::get_Saturation ( )
protected

◆ GetEffective()

System::SharedPtr<EffectEffectiveData> Aspose::Slides::Effects::HSL::GetEffective ( )
virtual

◆ GetEffective_()

System::SharedPtr<HSLEffectiveData> Aspose::Slides::Effects::HSL::GetEffective_ ( )
protected

◆ GetHashCode()

virtual int32_t Aspose::Slides::Effects::HSL::GetHashCode ( ) const
virtual

Serves as a hash function for a particular type.

Returns
A hash code for the current object.

Reimplemented from Aspose::Slides::PVIObject.

◆ GetStringData()

virtual System::String Aspose::Slides::Effects::HSL::GetStringData ( System::SharedPtr< IBaseSlide slide,
System::SharedPtr< FloatColor >  styleColor 
)
protectedvirtual

◆ set_Hue()

void Aspose::Slides::Effects::HSL::set_Hue ( float  value)
protected

◆ set_Luminance()

void Aspose::Slides::Effects::HSL::set_Luminance ( float  value)
protected

◆ set_Saturation()

void Aspose::Slides::Effects::HSL::set_Saturation ( float  value)
protected